feat(admin-cli): rename binary to nico-admin-cli; restructure operator docs#2339
Conversation
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
|
|
Caution Failed to replace (edit) comment. This is likely due to insufficient permissions or the comment being deleted. Error details |
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
docs/manuals/nico-admin-cli.md (1)
10-16:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winIncorrect package name in build commands.
The build commands use
-p nico-admin-cli, but per the PR description "The Cargo package name remains unchanged, so-p carbide-admin-clibuild invocations still work." The package name should remaincarbide-admin-clieven though the binary output is renamed tonico-admin-cli.📝 Proposed fix
# Debug build (faster compile, larger binary) -cargo build -p nico-admin-cli +cargo build -p carbide-admin-cli # Release build (optimized, for deployment) -cargo build -p nico-admin-cli --release +cargo build -p carbide-admin-cli --release🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/manuals/nico-admin-cli.md` around lines 10 - 16, The build commands incorrectly use the Cargo package name "nico-admin-cli"; update the commands in docs/manuals/nico-admin-cli.md to use the actual Cargo package name "carbide-admin-cli" (e.g., change occurrences of -p nico-admin-cli to -p carbide-admin-cli) while keeping any notes that the produced binary is renamed to "nico-admin-cli".crates/admin-cli/src/machine_validation/tests_cmd/args.rs (1)
61-61:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winCorrect the typographical error in help text.
Line 61 contains a spelling error: "unverfied" should be "unverified" in the help text
"List unverfied tests also.".🔧 Proposed fix
- #[clap(long, default_value = "false", help = "List unverfied tests also.")] + #[clap(long, default_value = "false", help = "List unverified tests also.")] pub show_un_verfied: bool,🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@crates/admin-cli/src/machine_validation/tests_cmd/args.rs` at line 61, Fix the typo in the clap help string: update the attribute #[clap(long, default_value = "false", help = "List unverfied tests also.")] so the help text reads "List unverified tests also." (i.e., change "unverfied" → "unverified") for the corresponding command-line argument declaration.
🧹 Nitpick comments (1)
crates/admin-cli/src/redfish/cmds.rs (1)
493-498: 💤 Low valueConsider adding user feedback for mode change commands.
The new
SetNicModehandler (lines 493-495) successfully calls the underlying Redfish API but provides no output to the user. Similarly, the adjacentSetDpuModehandler (lines 496-498) is silent.For consistency with other BIOS-modifying commands in this file (e.g.,
SerialEnableat line 262,LockdownEnableat line 149), consider printing a confirmation message indicating that the mode has been set and whether a system restart is required for the change to take effect.♻️ Optional enhancement for user feedback
SetNicMode => { redfish.set_nic_mode(NicMode::Nic).await?; + println!("NIC mode set. System restart may be required for changes to take effect."); } SetDpuMode => { redfish.set_nic_mode(NicMode::Dpu).await?; + println!("DPU mode set. System restart may be required for changes to take effect."); }🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@crates/admin-cli/src/redfish/cmds.rs` around lines 493 - 498, The SetNicMode and SetDpuMode match arms call redfish.set_nic_mode(...) but emit no user-facing output; update those handlers (SetNicMode and SetDpuMode) to print a confirmation message similar to SerialEnable and LockdownEnable (e.g., "NIC mode set to Nic" / "NIC mode set to DPU") and include whether a restart is required if the Redfish API indicates that (or conservatively append "restart may be required to apply changes"). Use the same logging/printing mechanism used elsewhere in this file to keep behavior consistent.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@crates/admin-cli/src/machine_validation/on_demand/args.rs`:
- Around line 29-30: Rename the mistyped flag and identifiers: change the CLI
flag string "--run-unverfied-tests" to "--run-unverified-tests", update the help
text "Run not verfified tests" to "Run unverified tests", and rename the
internal field/variable `run_unverfied_tests` to `run_unverified_tests` (and
update all references/usages, e.g., in the arg parser and any uses in functions
handling machine validation on-demand) so flag parsing, help output, and
internal code are consistent.
---
Outside diff comments:
In `@crates/admin-cli/src/machine_validation/tests_cmd/args.rs`:
- Line 61: Fix the typo in the clap help string: update the attribute
#[clap(long, default_value = "false", help = "List unverfied tests also.")] so
the help text reads "List unverified tests also." (i.e., change "unverfied" →
"unverified") for the corresponding command-line argument declaration.
In `@docs/manuals/nico-admin-cli.md`:
- Around line 10-16: The build commands incorrectly use the Cargo package name
"nico-admin-cli"; update the commands in docs/manuals/nico-admin-cli.md to use
the actual Cargo package name "carbide-admin-cli" (e.g., change occurrences of
-p nico-admin-cli to -p carbide-admin-cli) while keeping any notes that the
produced binary is renamed to "nico-admin-cli".
---
Nitpick comments:
In `@crates/admin-cli/src/redfish/cmds.rs`:
- Around line 493-498: The SetNicMode and SetDpuMode match arms call
redfish.set_nic_mode(...) but emit no user-facing output; update those handlers
(SetNicMode and SetDpuMode) to print a confirmation message similar to
SerialEnable and LockdownEnable (e.g., "NIC mode set to Nic" / "NIC mode set to
DPU") and include whether a restart is required if the Redfish API indicates
that (or conservatively append "restart may be required to apply changes"). Use
the same logging/printing mechanism used elsewhere in this file to keep behavior
consistent.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 58f019cb-a99e-4413-9b32-cec363926735
📒 Files selected for processing (300)
Makefile.tomlcrates/admin-cli/AGENTS.mdcrates/admin-cli/Cargo.tomlcrates/admin-cli/cli_domains.yamlcrates/admin-cli/src/attestation/measured_boot/bundle/args.rscrates/admin-cli/src/attestation/measured_boot/journal/args.rscrates/admin-cli/src/attestation/measured_boot/machine/args.rscrates/admin-cli/src/attestation/measured_boot/profile/args.rscrates/admin-cli/src/attestation/measured_boot/report/args.rscrates/admin-cli/src/attestation/measured_boot/site/args.rscrates/admin-cli/src/attestation/spdm/cancel/args.rscrates/admin-cli/src/attestation/spdm/get/args.rscrates/admin-cli/src/attestation/spdm/list/args.rscrates/admin-cli/src/attestation/spdm/trigger/args.rscrates/admin-cli/src/bmc_machine/admin_power_control/args.rscrates/admin-cli/src/bmc_machine/bmc_reset/args.rscrates/admin-cli/src/bmc_machine/create_bmc_user/args.rscrates/admin-cli/src/bmc_machine/delete_bmc_user/args.rscrates/admin-cli/src/bmc_machine/enable_infinite_boot/args.rscrates/admin-cli/src/bmc_machine/is_infinite_boot_enabled/args.rscrates/admin-cli/src/bmc_machine/lockdown/args.rscrates/admin-cli/src/bmc_machine/lockdown_status/args.rscrates/admin-cli/src/boot_override/clear/args.rscrates/admin-cli/src/boot_override/get/args.rscrates/admin-cli/src/boot_override/set/args.rscrates/admin-cli/src/browse/nmxc/args.rscrates/admin-cli/src/browse/redfish/args.rscrates/admin-cli/src/browse/ufm/args.rscrates/admin-cli/src/cfg/cli_options.rscrates/admin-cli/src/component_manager/power_control/args.rscrates/admin-cli/src/component_manager/status/args.rscrates/admin-cli/src/component_manager/update_firmware/args.rscrates/admin-cli/src/component_manager/versions/args.rscrates/admin-cli/src/compute_allocation/create/args.rscrates/admin-cli/src/compute_allocation/delete/args.rscrates/admin-cli/src/compute_allocation/show/args.rscrates/admin-cli/src/compute_allocation/update/args.rscrates/admin-cli/src/credential/add_bmc/args.rscrates/admin-cli/src/credential/add_dpu_factory_default/args.rscrates/admin-cli/src/credential/add_host_factory_default/args.rscrates/admin-cli/src/credential/add_nmxm/args.rscrates/admin-cli/src/credential/add_uefi/args.rscrates/admin-cli/src/credential/add_ufm/args.rscrates/admin-cli/src/credential/bgp/set_sitewide/args.rscrates/admin-cli/src/credential/delete_bmc/args.rscrates/admin-cli/src/credential/delete_nmxm/args.rscrates/admin-cli/src/credential/delete_ufm/args.rscrates/admin-cli/src/credential/generate_ufm_cert/args.rscrates/admin-cli/src/devenv/config/apply/args.rscrates/admin-cli/src/domain/show/args.rscrates/admin-cli/src/dpa/ensure/args.rscrates/admin-cli/src/dpa/show/args.rscrates/admin-cli/src/dpf/disable/args.rscrates/admin-cli/src/dpf/enable/args.rscrates/admin-cli/src/dpf/service_version/args.rscrates/admin-cli/src/dpf/show/args.rscrates/admin-cli/src/dpf/snapshot/args.rscrates/admin-cli/src/dpu/agent_upgrade_policy/args.rscrates/admin-cli/src/dpu/health_report/args.rscrates/admin-cli/src/dpu/network/args.rscrates/admin-cli/src/dpu/reprovision/args.rscrates/admin-cli/src/dpu/versions/args.rscrates/admin-cli/src/dpu_remediation/approve/args.rscrates/admin-cli/src/dpu_remediation/create/args.rscrates/admin-cli/src/dpu_remediation/disable/args.rscrates/admin-cli/src/dpu_remediation/enable/args.rscrates/admin-cli/src/dpu_remediation/list_applied/args.rscrates/admin-cli/src/dpu_remediation/revoke/args.rscrates/admin-cli/src/dpu_remediation/show/args.rscrates/admin-cli/src/expected_machines/add/args.rscrates/admin-cli/src/expected_machines/delete/args.rscrates/admin-cli/src/expected_machines/erase/args.rscrates/admin-cli/src/expected_machines/mod.rscrates/admin-cli/src/expected_machines/patch/args.rscrates/admin-cli/src/expected_machines/replace_all/args.rscrates/admin-cli/src/expected_machines/show/args.rscrates/admin-cli/src/expected_machines/update/args.rscrates/admin-cli/src/expected_power_shelf/add/args.rscrates/admin-cli/src/expected_power_shelf/delete/args.rscrates/admin-cli/src/expected_power_shelf/erase/args.rscrates/admin-cli/src/expected_power_shelf/replace_all/args.rscrates/admin-cli/src/expected_power_shelf/show/args.rscrates/admin-cli/src/expected_power_shelf/update/args.rscrates/admin-cli/src/expected_rack/add/args.rscrates/admin-cli/src/expected_rack/delete/args.rscrates/admin-cli/src/expected_rack/erase/args.rscrates/admin-cli/src/expected_rack/replace_all/args.rscrates/admin-cli/src/expected_rack/show/args.rscrates/admin-cli/src/expected_rack/update/args.rscrates/admin-cli/src/expected_switch/add/args.rscrates/admin-cli/src/expected_switch/delete/args.rscrates/admin-cli/src/expected_switch/erase/args.rscrates/admin-cli/src/expected_switch/replace_all/args.rscrates/admin-cli/src/expected_switch/show/args.rscrates/admin-cli/src/expected_switch/update/args.rscrates/admin-cli/src/extension_service/create/args.rscrates/admin-cli/src/extension_service/delete/args.rscrates/admin-cli/src/extension_service/get_version/args.rscrates/admin-cli/src/extension_service/show/args.rscrates/admin-cli/src/extension_service/show_instances/args.rscrates/admin-cli/src/extension_service/update/args.rscrates/admin-cli/src/firmware/show/args.rscrates/admin-cli/src/generate_docs/args.rscrates/admin-cli/src/generate_docs/cmds.rscrates/admin-cli/src/generate_man/args.rscrates/admin-cli/src/generate_man/cmds.rscrates/admin-cli/src/generate_shell_complete/args.rscrates/admin-cli/src/generate_shell_complete/cmds.rscrates/admin-cli/src/host/clear_uefi_password/args.rscrates/admin-cli/src/host/generate_host_uefi_password/args.rscrates/admin-cli/src/host/reprovision/args.rscrates/admin-cli/src/host/set_uefi_password/args.rscrates/admin-cli/src/ib_partition/show/args.rscrates/admin-cli/src/instance/allocate/args.rscrates/admin-cli/src/instance/reboot/args.rscrates/admin-cli/src/instance/release/args.rscrates/admin-cli/src/instance/show/args.rscrates/admin-cli/src/instance/update_ib_config/args.rscrates/admin-cli/src/instance/update_nvlink_config/args.rscrates/admin-cli/src/instance/update_os/args.rscrates/admin-cli/src/instance/update_spx_config/args.rscrates/admin-cli/src/instance_type/associate/args.rscrates/admin-cli/src/instance_type/create/args.rscrates/admin-cli/src/instance_type/delete/args.rscrates/admin-cli/src/instance_type/disassociate/args.rscrates/admin-cli/src/instance_type/show/args.rscrates/admin-cli/src/instance_type/update/args.rscrates/admin-cli/src/inventory/args.rscrates/admin-cli/src/ip/find/args.rscrates/admin-cli/src/ipxe_template/show/args.rscrates/admin-cli/src/jump/args.rscrates/admin-cli/src/machine/auto_update/args.rscrates/admin-cli/src/machine/force_delete/args.rscrates/admin-cli/src/machine/hardware_info/args.rscrates/admin-cli/src/machine/health_report/args.rscrates/admin-cli/src/machine/metadata/args.rscrates/admin-cli/src/machine/network/args.rscrates/admin-cli/src/machine/nvlink_info/args.rscrates/admin-cli/src/machine/positions/args.rscrates/admin-cli/src/machine/reboot/args.rscrates/admin-cli/src/machine/show/args.rscrates/admin-cli/src/machine_interfaces/assign_address/args.rscrates/admin-cli/src/machine_interfaces/delete/args.rscrates/admin-cli/src/machine_interfaces/remove_address/args.rscrates/admin-cli/src/machine_interfaces/show/args.rscrates/admin-cli/src/machine_interfaces/show_addresses/args.rscrates/admin-cli/src/machine_validation/external_config/args.rscrates/admin-cli/src/machine_validation/on_demand/args.rscrates/admin-cli/src/machine_validation/results/args.rscrates/admin-cli/src/machine_validation/runs/args.rscrates/admin-cli/src/machine_validation/tests_cmd/args.rscrates/admin-cli/src/managed_host/debug_bundle/args.rscrates/admin-cli/src/managed_host/maintenance/args.rscrates/admin-cli/src/managed_host/power_options/args.rscrates/admin-cli/src/managed_host/quarantine/args.rscrates/admin-cli/src/managed_host/reset_host_reprovisioning/args.rscrates/admin-cli/src/managed_host/set_primary_dpu/args.rscrates/admin-cli/src/managed_host/show/args.rscrates/admin-cli/src/managed_host/start_updates/args.rscrates/admin-cli/src/managed_switch/delete/args.rscrates/admin-cli/src/managed_switch/list/args.rscrates/admin-cli/src/managed_switch/show/args.rscrates/admin-cli/src/mlx/config/args.rscrates/admin-cli/src/mlx/connections/args.rscrates/admin-cli/src/mlx/info/args.rscrates/admin-cli/src/mlx/lockdown/args.rscrates/admin-cli/src/mlx/profile/args.rscrates/admin-cli/src/mlx/registry/args.rscrates/admin-cli/src/network_devices/show/args.rscrates/admin-cli/src/network_security_group/attach/args.rscrates/admin-cli/src/network_security_group/create/args.rscrates/admin-cli/src/network_security_group/delete/args.rscrates/admin-cli/src/network_security_group/detach/args.rscrates/admin-cli/src/network_security_group/show/args.rscrates/admin-cli/src/network_security_group/show_attachments/args.rscrates/admin-cli/src/network_security_group/update/args.rscrates/admin-cli/src/network_segment/delete/args.rscrates/admin-cli/src/network_segment/show/args.rscrates/admin-cli/src/nvl_domain/health_report/args.rscrates/admin-cli/src/nvl_logical_partition/create/args.rscrates/admin-cli/src/nvl_logical_partition/delete/args.rscrates/admin-cli/src/nvl_logical_partition/show/args.rscrates/admin-cli/src/nvl_partition/show/args.rscrates/admin-cli/src/nvlink_nmxc_endpoints/create.rscrates/admin-cli/src/nvlink_nmxc_endpoints/delete.rscrates/admin-cli/src/nvlink_nmxc_endpoints/show.rscrates/admin-cli/src/nvlink_nmxc_endpoints/update.rscrates/admin-cli/src/operating_system/create/args.rscrates/admin-cli/src/operating_system/delete/args.rscrates/admin-cli/src/operating_system/get_artifacts/args.rscrates/admin-cli/src/operating_system/set_cached_url/args.rscrates/admin-cli/src/operating_system/show/args.rscrates/admin-cli/src/operating_system/update/args.rscrates/admin-cli/src/os_image/create/args.rscrates/admin-cli/src/os_image/delete/args.rscrates/admin-cli/src/os_image/show/args.rscrates/admin-cli/src/os_image/update/args.rscrates/admin-cli/src/ping/args.rscrates/admin-cli/src/power_shelf/delete/args.rscrates/admin-cli/src/power_shelf/force_delete/args.rscrates/admin-cli/src/power_shelf/health_report/add/args.rscrates/admin-cli/src/power_shelf/health_report/remove/args.rscrates/admin-cli/src/power_shelf/health_report/show/args.rscrates/admin-cli/src/power_shelf/list/args.rscrates/admin-cli/src/power_shelf/maintenance/args.rscrates/admin-cli/src/power_shelf/metadata/args.rscrates/admin-cli/src/power_shelf/show/args.rscrates/admin-cli/src/rack/delete/args.rscrates/admin-cli/src/rack/list/args.rscrates/admin-cli/src/rack/maintenance/args.rscrates/admin-cli/src/rack/metadata/args.rscrates/admin-cli/src/rack/profile/show/args.rscrates/admin-cli/src/rack/show/args.rscrates/admin-cli/src/redfish/args.rscrates/admin-cli/src/redfish/cmds.rscrates/admin-cli/src/resource_pool/grow/args.rscrates/admin-cli/src/resource_pool/list/args.rscrates/admin-cli/src/rms/args.rscrates/admin-cli/src/route_server/add/args.rscrates/admin-cli/src/route_server/get/args.rscrates/admin-cli/src/route_server/remove/args.rscrates/admin-cli/src/route_server/replace/args.rscrates/admin-cli/src/scout_stream/mod.rscrates/admin-cli/src/set/bmc_proxy/args.rscrates/admin-cli/src/set/create_machines/args.rscrates/admin-cli/src/set/log_filter/args.rscrates/admin-cli/src/set/site_explorer_enabled/args.rscrates/admin-cli/src/set/tracing_enabled/args.rscrates/admin-cli/src/site_explorer/clear_error/args.rscrates/admin-cli/src/site_explorer/copy_bfb_to_dpu_rshim/args.rscrates/admin-cli/src/site_explorer/delete/args.rscrates/admin-cli/src/site_explorer/explore/args.rscrates/admin-cli/src/site_explorer/get_report/args.rscrates/admin-cli/src/site_explorer/have_credentials/args.rscrates/admin-cli/src/site_explorer/is_bmc_in_managed_host/args.rscrates/admin-cli/src/site_explorer/re_explore/args.rscrates/admin-cli/src/site_explorer/refresh_endpoint/args.rscrates/admin-cli/src/site_explorer/remediation/args.rscrates/admin-cli/src/sku/assign/args.rscrates/admin-cli/src/sku/bulk_update_metadata/args.rscrates/admin-cli/src/sku/common.rscrates/admin-cli/src/sku/delete/args.rscrates/admin-cli/src/sku/generate/args.rscrates/admin-cli/src/sku/replace/args.rscrates/admin-cli/src/sku/show_machines/args.rscrates/admin-cli/src/sku/unassign/args.rscrates/admin-cli/src/sku/update_metadata/args.rscrates/admin-cli/src/sku/verify/args.rscrates/admin-cli/src/spx_partition/show/args.rscrates/admin-cli/src/ssh/copy_bfb/args.rscrates/admin-cli/src/ssh/disable_rshim/args.rscrates/admin-cli/src/ssh/enable_rshim/args.rscrates/admin-cli/src/ssh/get_rshim_status/args.rscrates/admin-cli/src/ssh/show_obmc_log/args.rscrates/admin-cli/src/switch/force_delete/args.rscrates/admin-cli/src/switch/health_report/add/args.rscrates/admin-cli/src/switch/health_report/remove/args.rscrates/admin-cli/src/switch/health_report/show/args.rscrates/admin-cli/src/switch/list/args.rscrates/admin-cli/src/switch/metadata/args.rscrates/admin-cli/src/switch/show/args.rscrates/admin-cli/src/tenant/show/args.rscrates/admin-cli/src/tenant/update/args.rscrates/admin-cli/src/tenant_keyset/show/args.rscrates/admin-cli/src/tpm_ca/add/args.rscrates/admin-cli/src/tpm_ca/add_bulk/args.rscrates/admin-cli/src/tpm_ca/delete/args.rscrates/admin-cli/src/tpm_ca/show_unmatched_ek/args.rscrates/admin-cli/src/trim_table/measured_boot/args.rscrates/admin-cli/src/version/args.rscrates/admin-cli/src/version/cmds.rscrates/admin-cli/src/vpc/set_virtualizer/args.rscrates/admin-cli/src/vpc/show/args.rscrates/admin-cli/src/vpc_peering/create/args.rscrates/admin-cli/src/vpc_peering/delete/args.rscrates/admin-cli/src/vpc_peering/show/args.rscrates/admin-cli/src/vpc_prefix/create/args.rscrates/admin-cli/src/vpc_prefix/delete/args.rscrates/admin-cli/src/vpc_prefix/show/args.rsdev/deployment/devspace/Dockerfile.apidev/deployment/localdev/Dockerfile.api.localdevdev/deployment/localdev/Dockerfile.api.localdev.minikubedev/deployment/localdev/Dockerfile.forge-admin-cli.localdevdev/docker/Dockerfile.release-container-aarch64dev/docker/Dockerfile.release-container-sa-x86_64dev/docker/Dockerfile.release-container-x86_64dev/docker/Dockerfile.release-forge-clidocs/index.ymldocs/manuals/nico-admin-cli.mddocs/manuals/nico-admin-cli/admin.mddocs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-bundle-create.mddocs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-bundle-delete.mddocs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-bundle-find-closest-match-report.mddocs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-bundle-find-closest-match.mddocs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-bundle-list-all.mddocs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-bundle-list-machines.mddocs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-bundle-list.mddocs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-bundle-rename.mddocs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-bundle-set-state.mddocs/manuals/nico-admin-cli/commands/attestation/attestation-measured-boot-bundle-show.md
d43cb73 to
9bffa08
Compare
|
@Coco-Ben, would you review the layout of the docs? I tried to keep it mostly additive without changing the existing links |
|
@NVIDIA/dsx-sw-cicd the CI changes are pretty minimal, could you please give them a review |
|
/ok to test bafac92 |
| ```sh | ||
| NICO_API_AUTH="{permissive_mode=true}" | ||
| ``` | ||
| For the full command reference, see the [CLI manual index](./nico-admin-cli/index.md). |
There was a problem hiding this comment.
As it is right now, this link won't work because the new pages under /nico-admin-cli have not been added to the TOC in docs/index.yml. I'm OK with excluding the CLI reference from the rendered docs because it's a lot of stuff, in which case we'd need to change this to a permalink to the .md files in the GitHub repo (https://github.com/NVIDIA/infra-controller/tree/main/docs/manuals/nico-admin-cli/index.md)
There was a problem hiding this comment.
Understood.
There was a problem hiding this comment.
PTAL is this what you had in mind?
bafac92 to
245e07c
Compare
…r docs The binary produced by the `carbide-admin-cli` crate is renamed from `carbide-admin-cli` to `nico-admin-cli`. All `after_long_help` example invocations across ~250 command modules, the `BIN` constant in `generate_docs/cmds.rs`, and the `#[clap(name)]` attribute in `cli_options.rs` are updated to match. Eight container Dockerfiles are updated to copy `nico-admin-cli` and create backward-compatibility symlinks: `carbide-admin-cli` → `nico-admin-cli` in all images, and `forge-admin-cli` → `nico-admin-cli` where that symlink already existed. Corrected spelling of --run-unverified-tests on machine-validation Update autocomplete to use nico-admin-cli, as well as symlinks for carbide-admin-cli Generated docs are relocated from `docs/cli` to `docs/manuals/nico-admin-cli` Signed-off-by: Ian Anderson <ianderson@nvidia.com>
245e07c to
77809ef
Compare
Description
The binary produced by the
carbide-admin-clicrate is renamed fromcarbide-admin-clitonico-admin-cli.All
after_long_helpexample invocations across ~250 command modules, theBINconstant ingenerate_docs/cmds.rs, and the#[clap(name)]attribute incli_options.rsare updated to match.Eight container Dockerfiles are updated to copy
nico-admin-cliand create backward-compatibility symlinks:carbide-admin-cli→nico-admin-cliin all images, andforge-admin-cli→nico-admin-cliwhere that symlink already existed.Corrected spelling of --run-unverified-tests on machine-validation
Update autocomplete to use nico-admin-cli, as well as symlinks for carbide-admin-cli
Type of Change
Related Issues (Optional)
Fixes: #2011
Breaking Changes
carbide-admin-cliis now namednico-admin-cli. Containers will have a symlink tocarbide-admin-cliTesting
Additional Notes