From dbac4c271b2c11cdfe3b0389c0ce898c36f6cdc9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Wei=C3=9Fe?= Date: Fri, 3 May 2024 14:52:46 +0200 Subject: [PATCH] Fix CLI reference update action to set default config dir to $HOME/.config MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Daniel Weiße --- .github/workflows/update-cli-reference.yml | 2 +- docs/docs/reference/cli.md | 52 +++++++++++----------- 2 files changed, 27 insertions(+), 27 deletions(-) diff --git a/.github/workflows/update-cli-reference.yml b/.github/workflows/update-cli-reference.yml index 3d3f32ee..5a24c84d 100644 --- a/.github/workflows/update-cli-reference.yml +++ b/.github/workflows/update-cli-reference.yml @@ -25,7 +25,7 @@ jobs: git config --global --add safe.directory "$GITHUB_WORKSPACE" - name: Generate reference docs - run: go run . | cat header.md - > ../../cli.md + run: XDG_CONFIG_HOME=\$HOME/.config go run . | cat header.md - > ../../cli.md working-directory: hack/clidocgen - name: Get commit sha diff --git a/docs/docs/reference/cli.md b/docs/docs/reference/cli.md index 9515d475..06c16dd8 100644 --- a/docs/docs/reference/cli.md +++ b/docs/docs/reference/cli.md @@ -82,7 +82,7 @@ marblerun install --dcap-pccs-url https://pccs.example.com/sgx/certification/v4/ ``` --accepted-tcb-statuses strings Comma-separated list of user accepted TCB statuses (default [UpToDate,SWHardeningNeeded]) - --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/root/.config/marblerun/coordinator-cert.pem") + --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "$HOME/.config/marblerun/coordinator-cert.pem") --era-config string Path to a remote-attestation config file in JSON format. If none is provided, the command attempts to use './coordinator-era.json'. If that does not exist, the command will attempt to load a matching config file from the MarbleRun GitHub repository -i, --insecure Set to skip quote verification, needed when running in simulation mode -n, --namespace string Kubernetes namespace of the MarbleRun installation (default "marblerun") @@ -112,7 +112,7 @@ marblerun uninstall [flags] ``` --accepted-tcb-statuses strings Comma-separated list of user accepted TCB statuses (default [UpToDate,SWHardeningNeeded]) - --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/root/.config/marblerun/coordinator-cert.pem") + --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "$HOME/.config/marblerun/coordinator-cert.pem") --era-config string Path to a remote-attestation config file in JSON format. If none is provided, the command attempts to use './coordinator-era.json'. If that does not exist, the command will attempt to load a matching config file from the MarbleRun GitHub repository -i, --insecure Set to skip quote verification, needed when running in simulation mode -n, --namespace string Kubernetes namespace of the MarbleRun installation (default "marblerun") @@ -141,7 +141,7 @@ marblerun precheck [flags] ``` --accepted-tcb-statuses strings Comma-separated list of user accepted TCB statuses (default [UpToDate,SWHardeningNeeded]) - --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/root/.config/marblerun/coordinator-cert.pem") + --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "$HOME/.config/marblerun/coordinator-cert.pem") --era-config string Path to a remote-attestation config file in JSON format. If none is provided, the command attempts to use './coordinator-era.json'. If that does not exist, the command will attempt to load a matching config file from the MarbleRun GitHub repository -i, --insecure Set to skip quote verification, needed when running in simulation mode -n, --namespace string Kubernetes namespace of the MarbleRun installation (default "marblerun") @@ -171,7 +171,7 @@ marblerun check [flags] ``` --accepted-tcb-statuses strings Comma-separated list of user accepted TCB statuses (default [UpToDate,SWHardeningNeeded]) - --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/root/.config/marblerun/coordinator-cert.pem") + --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "$HOME/.config/marblerun/coordinator-cert.pem") --era-config string Path to a remote-attestation config file in JSON format. If none is provided, the command attempts to use './coordinator-era.json'. If that does not exist, the command will attempt to load a matching config file from the MarbleRun GitHub repository -i, --insecure Set to skip quote verification, needed when running in simulation mode -n, --namespace string Kubernetes namespace of the MarbleRun installation (default "marblerun") @@ -205,7 +205,7 @@ manifest set manifest.json example.com:4433 [--era-config=config.json] [--insecu ``` --accepted-tcb-statuses strings Comma-separated list of user accepted TCB statuses (default [UpToDate,SWHardeningNeeded]) - --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/root/.config/marblerun/coordinator-cert.pem") + --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "$HOME/.config/marblerun/coordinator-cert.pem") --era-config string Path to a remote-attestation config file in JSON format. If none is provided, the command attempts to use './coordinator-era.json'. If that does not exist, the command will attempt to load a matching config file from the MarbleRun GitHub repository -i, --insecure Set to skip quote verification, needed when running in simulation mode -n, --namespace string Kubernetes namespace of the MarbleRun installation (default "marblerun") @@ -245,7 +245,7 @@ marblerun manifest get $MARBLERUN -s --era-config=era.json ``` --accepted-tcb-statuses strings Comma-separated list of user accepted TCB statuses (default [UpToDate,SWHardeningNeeded]) - --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/root/.config/marblerun/coordinator-cert.pem") + --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "$HOME/.config/marblerun/coordinator-cert.pem") --era-config string Path to a remote-attestation config file in JSON format. If none is provided, the command attempts to use './coordinator-era.json'. If that does not exist, the command will attempt to load a matching config file from the MarbleRun GitHub repository -i, --insecure Set to skip quote verification, needed when running in simulation mode -n, --namespace string Kubernetes namespace of the MarbleRun installation (default "marblerun") @@ -283,7 +283,7 @@ marblerun manifest log $MARBLERUN ``` --accepted-tcb-statuses strings Comma-separated list of user accepted TCB statuses (default [UpToDate,SWHardeningNeeded]) - --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/root/.config/marblerun/coordinator-cert.pem") + --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "$HOME/.config/marblerun/coordinator-cert.pem") --era-config string Path to a remote-attestation config file in JSON format. If none is provided, the command attempts to use './coordinator-era.json'. If that does not exist, the command will attempt to load a matching config file from the MarbleRun GitHub repository -i, --insecure Set to skip quote verification, needed when running in simulation mode -n, --namespace string Kubernetes namespace of the MarbleRun installation (default "marblerun") @@ -319,7 +319,7 @@ marblerun manifest set manifest.json $MARBLERUN --recovery-data=recovery-secret. ``` --accepted-tcb-statuses strings Comma-separated list of user accepted TCB statuses (default [UpToDate,SWHardeningNeeded]) - --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/root/.config/marblerun/coordinator-cert.pem") + --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "$HOME/.config/marblerun/coordinator-cert.pem") --era-config string Path to a remote-attestation config file in JSON format. If none is provided, the command attempts to use './coordinator-era.json'. If that does not exist, the command will attempt to load a matching config file from the MarbleRun GitHub repository -i, --insecure Set to skip quote verification, needed when running in simulation mode -n, --namespace string Kubernetes namespace of the MarbleRun installation (default "marblerun") @@ -348,7 +348,7 @@ marblerun manifest signature [flags] ``` --accepted-tcb-statuses strings Comma-separated list of user accepted TCB statuses (default [UpToDate,SWHardeningNeeded]) - --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/root/.config/marblerun/coordinator-cert.pem") + --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "$HOME/.config/marblerun/coordinator-cert.pem") --era-config string Path to a remote-attestation config file in JSON format. If none is provided, the command attempts to use './coordinator-era.json'. If that does not exist, the command will attempt to load a matching config file from the MarbleRun GitHub repository -i, --insecure Set to skip quote verification, needed when running in simulation mode -n, --namespace string Kubernetes namespace of the MarbleRun installation (default "marblerun") @@ -373,7 +373,7 @@ Manage manifest updates for the MarbleRun Coordinator. ``` --accepted-tcb-statuses strings Comma-separated list of user accepted TCB statuses (default [UpToDate,SWHardeningNeeded]) - --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/root/.config/marblerun/coordinator-cert.pem") + --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "$HOME/.config/marblerun/coordinator-cert.pem") --era-config string Path to a remote-attestation config file in JSON format. If none is provided, the command attempts to use './coordinator-era.json'. If that does not exist, the command will attempt to load a matching config file from the MarbleRun GitHub repository -i, --insecure Set to skip quote verification, needed when running in simulation mode -n, --namespace string Kubernetes namespace of the MarbleRun installation (default "marblerun") @@ -413,7 +413,7 @@ marblerun manifest update apply update-manifest.json $MARBLERUN --cert=admin-cer ``` --accepted-tcb-statuses strings Comma-separated list of user accepted TCB statuses (default [UpToDate,SWHardeningNeeded]) - --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/root/.config/marblerun/coordinator-cert.pem") + --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "$HOME/.config/marblerun/coordinator-cert.pem") --era-config string Path to a remote-attestation config file in JSON format. If none is provided, the command attempts to use './coordinator-era.json'. If that does not exist, the command will attempt to load a matching config file from the MarbleRun GitHub repository -i, --insecure Set to skip quote verification, needed when running in simulation mode -n, --namespace string Kubernetes namespace of the MarbleRun installation (default "marblerun") @@ -454,7 +454,7 @@ marblerun manifest update acknowledge update-manifest.json $MARBLERUN --cert=adm ``` --accepted-tcb-statuses strings Comma-separated list of user accepted TCB statuses (default [UpToDate,SWHardeningNeeded]) - --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/root/.config/marblerun/coordinator-cert.pem") + --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "$HOME/.config/marblerun/coordinator-cert.pem") --era-config string Path to a remote-attestation config file in JSON format. If none is provided, the command attempts to use './coordinator-era.json'. If that does not exist, the command will attempt to load a matching config file from the MarbleRun GitHub repository -i, --insecure Set to skip quote verification, needed when running in simulation mode -n, --namespace string Kubernetes namespace of the MarbleRun installation (default "marblerun") @@ -491,7 +491,7 @@ marblerun manifest update cancel $MARBLERUN --cert=admin-cert.pem --key=admin-ke ``` --accepted-tcb-statuses strings Comma-separated list of user accepted TCB statuses (default [UpToDate,SWHardeningNeeded]) - --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/root/.config/marblerun/coordinator-cert.pem") + --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "$HOME/.config/marblerun/coordinator-cert.pem") --era-config string Path to a remote-attestation config file in JSON format. If none is provided, the command attempts to use './coordinator-era.json'. If that does not exist, the command will attempt to load a matching config file from the MarbleRun GitHub repository -i, --insecure Set to skip quote verification, needed when running in simulation mode -n, --namespace string Kubernetes namespace of the MarbleRun installation (default "marblerun") @@ -528,7 +528,7 @@ marblerun manifest update get $MARBLERUN --era-config=era.json ``` --accepted-tcb-statuses strings Comma-separated list of user accepted TCB statuses (default [UpToDate,SWHardeningNeeded]) - --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/root/.config/marblerun/coordinator-cert.pem") + --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "$HOME/.config/marblerun/coordinator-cert.pem") --era-config string Path to a remote-attestation config file in JSON format. If none is provided, the command attempts to use './coordinator-era.json'. If that does not exist, the command will attempt to load a matching config file from the MarbleRun GitHub repository -i, --insecure Set to skip quote verification, needed when running in simulation mode -n, --namespace string Kubernetes namespace of the MarbleRun installation (default "marblerun") @@ -563,7 +563,7 @@ marblerun manifest verify manifest.json $MARBLERUN ``` --accepted-tcb-statuses strings Comma-separated list of user accepted TCB statuses (default [UpToDate,SWHardeningNeeded]) - --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/root/.config/marblerun/coordinator-cert.pem") + --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "$HOME/.config/marblerun/coordinator-cert.pem") --era-config string Path to a remote-attestation config file in JSON format. If none is provided, the command attempts to use './coordinator-era.json'. If that does not exist, the command will attempt to load a matching config file from the MarbleRun GitHub repository -i, --insecure Set to skip quote verification, needed when running in simulation mode -n, --namespace string Kubernetes namespace of the MarbleRun installation (default "marblerun") @@ -588,7 +588,7 @@ Retrieves the certificate of the MarbleRun Coordinator ``` --accepted-tcb-statuses strings Comma-separated list of user accepted TCB statuses (default [UpToDate,SWHardeningNeeded]) - --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/root/.config/marblerun/coordinator-cert.pem") + --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "$HOME/.config/marblerun/coordinator-cert.pem") --era-config string Path to a remote-attestation config file in JSON format. If none is provided, the command attempts to use './coordinator-era.json'. If that does not exist, the command will attempt to load a matching config file from the MarbleRun GitHub repository -i, --insecure Set to skip quote verification, needed when running in simulation mode -n, --namespace string Kubernetes namespace of the MarbleRun installation (default "marblerun") @@ -618,7 +618,7 @@ marblerun certificate root [flags] ``` --accepted-tcb-statuses strings Comma-separated list of user accepted TCB statuses (default [UpToDate,SWHardeningNeeded]) - --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/root/.config/marblerun/coordinator-cert.pem") + --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "$HOME/.config/marblerun/coordinator-cert.pem") --era-config string Path to a remote-attestation config file in JSON format. If none is provided, the command attempts to use './coordinator-era.json'. If that does not exist, the command will attempt to load a matching config file from the MarbleRun GitHub repository -i, --insecure Set to skip quote verification, needed when running in simulation mode -n, --namespace string Kubernetes namespace of the MarbleRun installation (default "marblerun") @@ -648,7 +648,7 @@ marblerun certificate intermediate [flags] ``` --accepted-tcb-statuses strings Comma-separated list of user accepted TCB statuses (default [UpToDate,SWHardeningNeeded]) - --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/root/.config/marblerun/coordinator-cert.pem") + --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "$HOME/.config/marblerun/coordinator-cert.pem") --era-config string Path to a remote-attestation config file in JSON format. If none is provided, the command attempts to use './coordinator-era.json'. If that does not exist, the command will attempt to load a matching config file from the MarbleRun GitHub repository -i, --insecure Set to skip quote verification, needed when running in simulation mode -n, --namespace string Kubernetes namespace of the MarbleRun installation (default "marblerun") @@ -678,7 +678,7 @@ marblerun certificate chain [flags] ``` --accepted-tcb-statuses strings Comma-separated list of user accepted TCB statuses (default [UpToDate,SWHardeningNeeded]) - --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/root/.config/marblerun/coordinator-cert.pem") + --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "$HOME/.config/marblerun/coordinator-cert.pem") --era-config string Path to a remote-attestation config file in JSON format. If none is provided, the command attempts to use './coordinator-era.json'. If that does not exist, the command will attempt to load a matching config file from the MarbleRun GitHub repository -i, --insecure Set to skip quote verification, needed when running in simulation mode -n, --namespace string Kubernetes namespace of the MarbleRun installation (default "marblerun") @@ -707,7 +707,7 @@ Set or retrieve a secret defined in the manifest. ``` --accepted-tcb-statuses strings Comma-separated list of user accepted TCB statuses (default [UpToDate,SWHardeningNeeded]) - --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/root/.config/marblerun/coordinator-cert.pem") + --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "$HOME/.config/marblerun/coordinator-cert.pem") --era-config string Path to a remote-attestation config file in JSON format. If none is provided, the command attempts to use './coordinator-era.json'. If that does not exist, the command will attempt to load a matching config file from the MarbleRun GitHub repository -i, --insecure Set to skip quote verification, needed when running in simulation mode -n, --namespace string Kubernetes namespace of the MarbleRun installation (default "marblerun") @@ -755,7 +755,7 @@ marblerun secret set certificate.pem $MARBLERUN -c admin.crt -k admin.key --from ``` --accepted-tcb-statuses strings Comma-separated list of user accepted TCB statuses (default [UpToDate,SWHardeningNeeded]) -c, --cert string PEM encoded MarbleRun user certificate file (required) - --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/root/.config/marblerun/coordinator-cert.pem") + --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "$HOME/.config/marblerun/coordinator-cert.pem") --era-config string Path to a remote-attestation config file in JSON format. If none is provided, the command attempts to use './coordinator-era.json'. If that does not exist, the command will attempt to load a matching config file from the MarbleRun GitHub repository -i, --insecure Set to skip quote verification, needed when running in simulation mode -k, --key string PEM encoded MarbleRun user key file (required) @@ -797,7 +797,7 @@ marblerun secret get genericSecret symmetricKeyShared $MARBLERUN -c admin.crt -k ``` --accepted-tcb-statuses strings Comma-separated list of user accepted TCB statuses (default [UpToDate,SWHardeningNeeded]) -c, --cert string PEM encoded MarbleRun user certificate file (required) - --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/root/.config/marblerun/coordinator-cert.pem") + --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "$HOME/.config/marblerun/coordinator-cert.pem") --era-config string Path to a remote-attestation config file in JSON format. If none is provided, the command attempts to use './coordinator-era.json'. If that does not exist, the command will attempt to load a matching config file from the MarbleRun GitHub repository -i, --insecure Set to skip quote verification, needed when running in simulation mode -k, --key string PEM encoded MarbleRun user key file (required) @@ -843,7 +843,7 @@ marblerun status [flags] ``` --accepted-tcb-statuses strings Comma-separated list of user accepted TCB statuses (default [UpToDate,SWHardeningNeeded]) - --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/root/.config/marblerun/coordinator-cert.pem") + --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "$HOME/.config/marblerun/coordinator-cert.pem") --era-config string Path to a remote-attestation config file in JSON format. If none is provided, the command attempts to use './coordinator-era.json'. If that does not exist, the command will attempt to load a matching config file from the MarbleRun GitHub repository -i, --insecure Set to skip quote verification, needed when running in simulation mode -n, --namespace string Kubernetes namespace of the MarbleRun installation (default "marblerun") @@ -878,7 +878,7 @@ marblerun recover recovery_key_decrypted $MARBLERUN ``` --accepted-tcb-statuses strings Comma-separated list of user accepted TCB statuses (default [UpToDate,SWHardeningNeeded]) - --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/root/.config/marblerun/coordinator-cert.pem") + --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "$HOME/.config/marblerun/coordinator-cert.pem") --era-config string Path to a remote-attestation config file in JSON format. If none is provided, the command attempts to use './coordinator-era.json'. If that does not exist, the command will attempt to load a matching config file from the MarbleRun GitHub repository -i, --insecure Set to skip quote verification, needed when running in simulation mode -n, --namespace string Kubernetes namespace of the MarbleRun installation (default "marblerun") @@ -907,7 +907,7 @@ marblerun package-info [flags] ``` --accepted-tcb-statuses strings Comma-separated list of user accepted TCB statuses (default [UpToDate,SWHardeningNeeded]) - --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/root/.config/marblerun/coordinator-cert.pem") + --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "$HOME/.config/marblerun/coordinator-cert.pem") --era-config string Path to a remote-attestation config file in JSON format. If none is provided, the command attempts to use './coordinator-era.json'. If that does not exist, the command will attempt to load a matching config file from the MarbleRun GitHub repository -i, --insecure Set to skip quote verification, needed when running in simulation mode -n, --namespace string Kubernetes namespace of the MarbleRun installation (default "marblerun") @@ -936,7 +936,7 @@ marblerun version [flags] ``` --accepted-tcb-statuses strings Comma-separated list of user accepted TCB statuses (default [UpToDate,SWHardeningNeeded]) - --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/root/.config/marblerun/coordinator-cert.pem") + --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "$HOME/.config/marblerun/coordinator-cert.pem") --era-config string Path to a remote-attestation config file in JSON format. If none is provided, the command attempts to use './coordinator-era.json'. If that does not exist, the command will attempt to load a matching config file from the MarbleRun GitHub repository -i, --insecure Set to skip quote verification, needed when running in simulation mode -n, --namespace string Kubernetes namespace of the MarbleRun installation (default "marblerun")