diff --git a/docs/docs/reference/cli.md b/docs/docs/reference/cli.md index da2580a0..c2ed4115 100644 --- a/docs/docs/reference/cli.md +++ b/docs/docs/reference/cli.md @@ -83,7 +83,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 (e.g. ConfigurationNeeded,ConfigurationAndSWHardeningNeeded) (default [UpToDate]) --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/github/home/.config/marblerun/coordinator-cert.pem") - --era-config string Path to remote attestation config file in json format, if none provided the newest configuration will be loaded from github + --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 (e.g. ConfigurationNeeded,ConfigurationAndSWHardeningNeeded) (default [UpToDate]) --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/github/home/.config/marblerun/coordinator-cert.pem") - --era-config string Path to remote attestation config file in json format, if none provided the newest configuration will be loaded from github + --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") ``` @@ -140,7 +140,7 @@ marblerun precheck [flags] ``` --accepted-tcb-statuses strings Comma-separated list of user accepted TCB statuses (e.g. ConfigurationNeeded,ConfigurationAndSWHardeningNeeded) (default [UpToDate]) --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/github/home/.config/marblerun/coordinator-cert.pem") - --era-config string Path to remote attestation config file in json format, if none provided the newest configuration will be loaded from github + --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") ``` @@ -169,7 +169,7 @@ marblerun check [flags] ``` --accepted-tcb-statuses strings Comma-separated list of user accepted TCB statuses (e.g. ConfigurationNeeded,ConfigurationAndSWHardeningNeeded) (default [UpToDate]) --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/github/home/.config/marblerun/coordinator-cert.pem") - --era-config string Path to remote attestation config file in json format, if none provided the newest configuration will be loaded from github + --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") ``` @@ -202,7 +202,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 (e.g. ConfigurationNeeded,ConfigurationAndSWHardeningNeeded) (default [UpToDate]) --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/github/home/.config/marblerun/coordinator-cert.pem") - --era-config string Path to remote attestation config file in json format, if none provided the newest configuration will be loaded from github + --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") ``` @@ -241,7 +241,7 @@ marblerun manifest get $MARBLERUN -s --era-config=era.json ``` --accepted-tcb-statuses strings Comma-separated list of user accepted TCB statuses (e.g. ConfigurationNeeded,ConfigurationAndSWHardeningNeeded) (default [UpToDate]) --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/github/home/.config/marblerun/coordinator-cert.pem") - --era-config string Path to remote attestation config file in json format, if none provided the newest configuration will be loaded from github + --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") ``` @@ -278,7 +278,7 @@ marblerun manifest log $MARBLERUN ``` --accepted-tcb-statuses strings Comma-separated list of user accepted TCB statuses (e.g. ConfigurationNeeded,ConfigurationAndSWHardeningNeeded) (default [UpToDate]) --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/github/home/.config/marblerun/coordinator-cert.pem") - --era-config string Path to remote attestation config file in json format, if none provided the newest configuration will be loaded from github + --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") ``` @@ -313,7 +313,7 @@ marblerun manifest set manifest.json $MARBLERUN --recovery-data=recovery-secret. ``` --accepted-tcb-statuses strings Comma-separated list of user accepted TCB statuses (e.g. ConfigurationNeeded,ConfigurationAndSWHardeningNeeded) (default [UpToDate]) --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/github/home/.config/marblerun/coordinator-cert.pem") - --era-config string Path to remote attestation config file in json format, if none provided the newest configuration will be loaded from github + --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") ``` @@ -341,7 +341,7 @@ marblerun manifest signature [flags] ``` --accepted-tcb-statuses strings Comma-separated list of user accepted TCB statuses (e.g. ConfigurationNeeded,ConfigurationAndSWHardeningNeeded) (default [UpToDate]) --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/github/home/.config/marblerun/coordinator-cert.pem") - --era-config string Path to remote attestation config file in json format, if none provided the newest configuration will be loaded from github + --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") ``` @@ -365,7 +365,7 @@ Manage manifest updates for the MarbleRun Coordinator. ``` --accepted-tcb-statuses strings Comma-separated list of user accepted TCB statuses (e.g. ConfigurationNeeded,ConfigurationAndSWHardeningNeeded) (default [UpToDate]) --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/github/home/.config/marblerun/coordinator-cert.pem") - --era-config string Path to remote attestation config file in json format, if none provided the newest configuration will be loaded from github + --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") ``` @@ -404,7 +404,7 @@ marblerun manifest update apply update-manifest.json $MARBLERUN --cert=admin-cer ``` --accepted-tcb-statuses strings Comma-separated list of user accepted TCB statuses (e.g. ConfigurationNeeded,ConfigurationAndSWHardeningNeeded) (default [UpToDate]) --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/github/home/.config/marblerun/coordinator-cert.pem") - --era-config string Path to remote attestation config file in json format, if none provided the newest configuration will be loaded from github + --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") ``` @@ -444,7 +444,7 @@ marblerun manifest update acknowledge update-manifest.json $MARBLERUN --cert=adm ``` --accepted-tcb-statuses strings Comma-separated list of user accepted TCB statuses (e.g. ConfigurationNeeded,ConfigurationAndSWHardeningNeeded) (default [UpToDate]) --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/github/home/.config/marblerun/coordinator-cert.pem") - --era-config string Path to remote attestation config file in json format, if none provided the newest configuration will be loaded from github + --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") ``` @@ -480,7 +480,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 (e.g. ConfigurationNeeded,ConfigurationAndSWHardeningNeeded) (default [UpToDate]) --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/github/home/.config/marblerun/coordinator-cert.pem") - --era-config string Path to remote attestation config file in json format, if none provided the newest configuration will be loaded from github + --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") ``` @@ -516,7 +516,7 @@ marblerun manifest update get $MARBLERUN --era-config=era.json ``` --accepted-tcb-statuses strings Comma-separated list of user accepted TCB statuses (e.g. ConfigurationNeeded,ConfigurationAndSWHardeningNeeded) (default [UpToDate]) --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/github/home/.config/marblerun/coordinator-cert.pem") - --era-config string Path to remote attestation config file in json format, if none provided the newest configuration will be loaded from github + --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") ``` @@ -550,7 +550,7 @@ marblerun manifest verify manifest.json $MARBLERUN ``` --accepted-tcb-statuses strings Comma-separated list of user accepted TCB statuses (e.g. ConfigurationNeeded,ConfigurationAndSWHardeningNeeded) (default [UpToDate]) --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/github/home/.config/marblerun/coordinator-cert.pem") - --era-config string Path to remote attestation config file in json format, if none provided the newest configuration will be loaded from github + --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") ``` @@ -574,7 +574,7 @@ Retrieves the certificate of the MarbleRun Coordinator ``` --accepted-tcb-statuses strings Comma-separated list of user accepted TCB statuses (e.g. ConfigurationNeeded,ConfigurationAndSWHardeningNeeded) (default [UpToDate]) --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/github/home/.config/marblerun/coordinator-cert.pem") - --era-config string Path to remote attestation config file in json format, if none provided the newest configuration will be loaded from github + --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") ``` @@ -603,7 +603,7 @@ marblerun certificate root [flags] ``` --accepted-tcb-statuses strings Comma-separated list of user accepted TCB statuses (e.g. ConfigurationNeeded,ConfigurationAndSWHardeningNeeded) (default [UpToDate]) --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/github/home/.config/marblerun/coordinator-cert.pem") - --era-config string Path to remote attestation config file in json format, if none provided the newest configuration will be loaded from github + --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") ``` @@ -632,7 +632,7 @@ marblerun certificate intermediate [flags] ``` --accepted-tcb-statuses strings Comma-separated list of user accepted TCB statuses (e.g. ConfigurationNeeded,ConfigurationAndSWHardeningNeeded) (default [UpToDate]) --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/github/home/.config/marblerun/coordinator-cert.pem") - --era-config string Path to remote attestation config file in json format, if none provided the newest configuration will be loaded from github + --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") ``` @@ -661,7 +661,7 @@ marblerun certificate chain [flags] ``` --accepted-tcb-statuses strings Comma-separated list of user accepted TCB statuses (e.g. ConfigurationNeeded,ConfigurationAndSWHardeningNeeded) (default [UpToDate]) --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/github/home/.config/marblerun/coordinator-cert.pem") - --era-config string Path to remote attestation config file in json format, if none provided the newest configuration will be loaded from github + --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") ``` @@ -689,7 +689,7 @@ Set or retrieve a secret defined in the manifest. ``` --accepted-tcb-statuses strings Comma-separated list of user accepted TCB statuses (e.g. ConfigurationNeeded,ConfigurationAndSWHardeningNeeded) (default [UpToDate]) --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/github/home/.config/marblerun/coordinator-cert.pem") - --era-config string Path to remote attestation config file in json format, if none provided the newest configuration will be loaded from github + --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") ``` @@ -736,7 +736,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 (e.g. ConfigurationNeeded,ConfigurationAndSWHardeningNeeded) (default [UpToDate]) -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 "/github/home/.config/marblerun/coordinator-cert.pem") - --era-config string Path to remote attestation config file in json format, if none provided the newest configuration will be loaded from github + --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) -n, --namespace string Kubernetes namespace of the MarbleRun installation (default "marblerun") @@ -777,7 +777,7 @@ marblerun secret get genericSecret symmetricKeyShared $MARBLERUN -c admin.crt -k --accepted-tcb-statuses strings Comma-separated list of user accepted TCB statuses (e.g. ConfigurationNeeded,ConfigurationAndSWHardeningNeeded) (default [UpToDate]) -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 "/github/home/.config/marblerun/coordinator-cert.pem") - --era-config string Path to remote attestation config file in json format, if none provided the newest configuration will be loaded from github + --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) -n, --namespace string Kubernetes namespace of the MarbleRun installation (default "marblerun") @@ -822,7 +822,7 @@ marblerun status [flags] ``` --accepted-tcb-statuses strings Comma-separated list of user accepted TCB statuses (e.g. ConfigurationNeeded,ConfigurationAndSWHardeningNeeded) (default [UpToDate]) --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/github/home/.config/marblerun/coordinator-cert.pem") - --era-config string Path to remote attestation config file in json format, if none provided the newest configuration will be loaded from github + --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") ``` @@ -856,7 +856,7 @@ marblerun recover recovery_key_decrypted $MARBLERUN ``` --accepted-tcb-statuses strings Comma-separated list of user accepted TCB statuses (e.g. ConfigurationNeeded,ConfigurationAndSWHardeningNeeded) (default [UpToDate]) --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/github/home/.config/marblerun/coordinator-cert.pem") - --era-config string Path to remote attestation config file in json format, if none provided the newest configuration will be loaded from github + --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") ``` @@ -884,7 +884,7 @@ marblerun package-info [flags] ``` --accepted-tcb-statuses strings Comma-separated list of user accepted TCB statuses (e.g. ConfigurationNeeded,ConfigurationAndSWHardeningNeeded) (default [UpToDate]) --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/github/home/.config/marblerun/coordinator-cert.pem") - --era-config string Path to remote attestation config file in json format, if none provided the newest configuration will be loaded from github + --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") ``` @@ -912,7 +912,7 @@ marblerun version [flags] ``` --accepted-tcb-statuses strings Comma-separated list of user accepted TCB statuses (e.g. ConfigurationNeeded,ConfigurationAndSWHardeningNeeded) (default [UpToDate]) --coordinator-cert string Path to MarbleRun Coordinator's root certificate to use for TLS connections (default "/github/home/.config/marblerun/coordinator-cert.pem") - --era-config string Path to remote attestation config file in json format, if none provided the newest configuration will be loaded from github + --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") ```