update docs of runtime options

Signed-off-by: t-kikuc <[email protected]>
pipe-cd · Oct 2, 2024 · dc2e877 · dc2e877
1 parent 85d1636
commit dc2e877
Showing 1 changed file with 22 additions and 19 deletions.
diff --git a/docs/content/en/docs-dev/user-guide/managing-piped/runtime-options.md b/docs/content/en/docs-dev/user-guide/managing-piped/runtime-options.md
@@ -20,6 +20,7 @@ Flags:
       --app-manifest-cache-count int               The number of app manifests to cache. The cache-key contains the commit hash. The default is 150. (default 150)     
       --cert-file string                           The path to the TLS certificate file.
       --config-aws-secret string                   The ARN of secret that contains Piped config and be stored in AWS Secrets Manager.
+      --config-aws-ssm-parameter string            The name of parameter of Piped config stored in AWS Systems Manager Parameter Store. SecureString is also supported.
       --config-data string                         The base64 encoded string of the configuration data.
       --config-file string                         The path to the configuration file.
       --config-gcp-secret string                   The resource ID of secret that contains Piped config and be stored in GCP SecretManager.
@@ -46,25 +47,27 @@ Usage:
   launcher launcher [flags]
 
 Flags:
-      --aws-secret-id string           The ARN of secret that contains Piped config in AWS Secrets Manager service.
-      --cert-file string               The path to the TLS certificate file.
-      --check-interval duration        Interval to periodically check desired config/version to restart Piped. Default is 1m. (default 1m0s)
-      --config-data string             The base64 encoded string of the configuration data.
-      --config-file string             The path to the configuration file.
-      --config-from-aws-secret         Whether to load Piped config that is being stored in AWS Secrets Manager service.
-      --config-from-gcp-secret         Whether to load Piped config that is being stored in GCP SecretManager service.
-      --config-from-git-repo           Whether to load Piped config that is being stored in a git repository.
-      --default-version string         The version should be run when no desired version was specified. Empty means using the same version with Launcher.
-      --gcp-secret-id string           The resource ID of secret that contains Piped config in GCP SecretManager service.
-      --git-branch string              Branch of git repository to for Piped config.
-      --git-piped-config-file string   Relative path within git repository to locate Piped config file.
-      --git-repo-url string            The remote URL of git repository to fetch Piped config.
-      --git-ssh-key-file string        The path to SSH private key to fetch private git repository.
-      --grace-period duration          How long to wait for graceful shutdown. (default 30s)
-  -h, --help                           help for launcher
-      --home-dir string                The working directory of Launcher.
-      --insecure                       Whether disabling transport security while connecting to control-plane.
-      --launcher-admin-port int        The port number used to run a HTTP server for admin tasks such as metrics, healthz.
+      --aws-secret-id string                  The ARN of secret that contains Piped config in AWS Secrets Manager service.
+      --aws-ssm-parameter string              The name of parameter of Piped config stored in AWS Systems Manager Parameter Store. SecureString is also supported.
+      --cert-file string                      The path to the TLS certificate file.
+      --check-interval duration               Interval to periodically check desired config/version to restart Piped. Default is 1m. (default 1m0s)
+      --config-data string                    The base64 encoded string of the configuration data.
+      --config-file string                    The path to the configuration file.
+      --config-from-aws-secret                Whether to load Piped config that is being stored in AWS Secrets Manager service.
+      --config-from-aws-ssm-parameter-store   Whether to load Piped config that is being stored in AWS Systems Manager Parameter Store.
+      --config-from-gcp-secret                Whether to load Piped config that is being stored in GCP SecretManager service.
+      --config-from-git-repo                  Whether to load Piped config that is being stored in a git repository.
+      --default-version string                The version should be run when no desired version was specified. Empty means using the same version with Launcher.
+      --gcp-secret-id string                  The resource ID of secret that contains Piped config in GCP SecretManager service.
+      --git-branch string                     Branch of git repository to for Piped config.
+      --git-piped-config-file string          Relative path within git repository to locate Piped config file.
+      --git-repo-url string                   The remote URL of git repository to fetch Piped config.
+      --git-ssh-key-file string               The path to SSH private key to fetch private git repository.
+      --grace-period duration                 How long to wait for graceful shutdown. (default 30s)
+  -h, --help                                  help for launcher
+      --home-dir string                       The working directory of Launcher.
+      --insecure                              Whether disabling transport security while connecting to control-plane.
+      --launcher-admin-port int               The port number used to run a HTTP server for admin tasks such as metrics, healthz.
 
 Global Flags:
       --log-encoding string                The encoding type for logger [json|console|humanize]. (default "humanize")