-
Notifications
You must be signed in to change notification settings - Fork 99
doc(helm): how to get client key and certs #1966
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,7 +6,7 @@ Once you have NVIDIA Infra Controller (NICo) up and running, you can begin inges | |
|
|
||
| Ensure you have the following prerequisites met before ingesting machines: | ||
|
|
||
| 1. You have the `carbide-admin-cli` command available: You can compile it from sources or you can use the pre-compiled binary. Another choice is to use a containerized version. | ||
| 1. You have the `carbide-admin-cli` command available: You can compile it from sources or you can use the pre-compiled binary. Another choice is to use a containerized version. You can also download it from the cluster; see next section for details. | ||
|
|
||
| 2. You can access the NICo site using the `carbide-admin-cli`. | ||
|
|
||
|
|
@@ -21,6 +21,78 @@ Ensure you have the following prerequisites met before ingesting machines: | |
| - The host BMC username (typically this is the factory default username) | ||
| - The host BMC password (typically this is the factory default password) | ||
|
|
||
| ## Get client key and certificate needed for carbide-admin-cli | ||
| These can be generated from site vault. Follow these steps to generate them. | ||
| ### Prerequisites | ||
|
|
||
| 1. Check `additional_issuer_cns` (one-time per cluster) | ||
| ``` | ||
| kubectl get configmap -n nico-system nico-api-config-files -o yaml | grep -i "additional_issuer_cns" | ||
| ``` | ||
| Expected: `additional_issuer_cns = ["site-root"]` | ||
|
|
||
| If it's empty, edit the configmap and set it, then restart: | ||
|
|
||
| ```bash | ||
| kubectl -n nico-system edit configmap nico-api-config-files | ||
| # under [auth.trust]: additional_issuer_cns = ["site-root"] | ||
|
|
||
| kubectl rollout restart deployment/nico-api -n nico-system | ||
| ``` | ||
|
|
||
| 2. Get the CLI binary - You can skip this step you already have carbide-admin-cli binary. | ||
| ```bash | ||
| POD=$(kubectl -n nico-system get pods -l app.kubernetes.io/name=nico-api -o jsonpath='{.items[0].metadata.name}') | ||
| kubectl -n nico-system cp "${POD}:/opt/carbide/carbide-admin-cli" /usr/local/bin/carbide-admin-cli | ||
| chmod +x /usr/local/bin/carbide-admin-cli | ||
| # verify that it is working | ||
| carbide-admin-cli | ||
| ``` | ||
|
|
||
| 3. Issue a client cert from Vault | ||
| ```bash | ||
| VAULT_TOKEN=$(kubectl -n vault get secret vaultroottoken -o jsonpath='{.data.token}' | base64 -d) | ||
| kubectl -n vault exec vault-0 -- env VAULT_SKIP_VERIFY=true VAULT_TOKEN="$VAULT_TOKEN" \ | ||
| vault write -format=json nicoca/issue/nico-cluster \ | ||
| common_name="<FQDN for nico-api-endpoint>" \ | ||
| ttl=720h > /tmp/issued.json | ||
| ``` | ||
|
|
||
| Replace `<FQDN for nico-api-endpoint>` appropriately which usually is `api-<ENVIRONMENT_NAME>.<SITE_DOMAIN_NAME>` | ||
|
|
||
| 4. Extract PEM files | ||
| ```bash | ||
| cat /tmp/issued.json | jq -r '.data.private_key' > /path/to/client.key | ||
| cat /tmp/issued.json | jq -r '.data.certificate' > /path/to/client.crt | ||
| cat /tmp/issued.json | jq -r '.data.issuing_ca' > /path/to/ca.crt | ||
| ``` | ||
|
|
||
| You can run admin cli commands as | ||
| ```bash | ||
| carbide-admin-cli https://api-<ENVIRONMENT_NAME>.<SITE_DOMAIN_NAME> --forge-root-ca-path /path/to/ca.crt --client-cert-path /path/to/client.crt --client-key-path /path/to/client.key <command> ... | ||
| ``` | ||
| Alternatively to shorten the command line you can create a file named `carbide_api_cli.json` in folder `$HOME/.config` and add the following content: | ||
| ```json | ||
| { | ||
| "carbide_api_url": "https://api-<ENVIRONMENT_NAME>.<SITE_DOMAIN_NAME>:443", | ||
| "forge_root_ca_path": "/path/to/ca.crt", | ||
| "client_cert_path": "/path/to/client.crt", | ||
| "client_key_path": "/path/to/client.key" | ||
| } | ||
|
|
||
| ``` | ||
| 5. Add `/etc/hosts` entry | ||
|
|
||
| If you have trouble resolving `api-<ENVIRONMENT_NAME>.<SITE_DOMAIN_NAME>` you have to map it to the LoadBalancer IP: | ||
|
|
||
| ```bash | ||
| CARBIDE_LB_IP=$(kubectl -n nico-system get svc nico-api-external \ | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. can you please change this to NICO_LB_IP
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I will |
||
| -o jsonpath='{.status.loadBalancer.ingress[0].ip}') | ||
|
|
||
| grep -q "api-<ENVIRONMENT_NAME>.<SITE_DOMAIN_NAME>" /etc/hosts || \ | ||
| echo "$CARBIDE_LB_IP api-<ENVIRONMENT_NAME>.<SITE_DOMAIN_NAME>" | sudo tee -a /etc/hosts | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this needs to change to NICO_LB_IP |
||
| ``` | ||
|
|
||
| ## Update Site | ||
|
|
||
| NICo requires knowledge of the current and desired BMC and UEFI credentials for hosts and DPUs. NICo will reset current crendtials to the desired credentials on the BMC and UEFI when ingesting a host. You can use these credentials when accessing the host or DPU BMC yourself, and NICo will use these credentials for its automated processes. | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should start transitioning these to nico-admin-cli since that will be coming in a larger code change next week.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We will open a ticket when that merge in?