From 5d8f6528caf57c0118267c1e022f99ed5a08d271 Mon Sep 17 00:00:00 2001 From: Kim Christensen Date: Wed, 22 May 2024 22:40:48 +0200 Subject: [PATCH] Update the magefile DocsBuild target to new location of CLI reference PR #2897 moved the CLI reference file, but the CLI reference generation still points to the old location. Signed-off-by: Kim Christensen --- docs/content/docs/references/cli/_index.md | 15 ---- docs/content/docs/references/cli/archive.md | 10 ++- docs/content/docs/references/cli/bundles.md | 42 ++++++++++ .../docs/references/cli/bundles/_index.md | 39 ---------- .../archive.md => bundles_archive.md} | 10 ++- .../{bundles/build.md => bundles_build.md} | 0 .../cli/{bundles/copy.md => bundles_copy.md} | 0 .../{bundles/create.md => bundles_create.md} | 2 +- .../explain.md => bundles_explain.md} | 0 .../inspect.md => bundles_inspect.md} | 2 - .../cli/{bundles/lint.md => bundles_lint.md} | 0 docs/content/docs/references/cli/create.md | 2 +- .../docs/references/cli/credentials.md | 38 +++++++++ .../docs/references/cli/credentials/_index.md | 35 --------- .../apply.md => credentials_apply.md} | 0 .../create.md => credentials_create.md} | 0 .../delete.md => credentials_delete.md} | 0 .../edit.md => credentials_edit.md} | 0 .../generate.md => credentials_generate.md} | 0 .../list.md => credentials_list.md} | 0 .../show.md => credentials_show.md} | 0 docs/content/docs/references/cli/install.md | 34 ++++---- .../docs/references/cli/installations.md | 46 +++++++++++ .../references/cli/installations/_index.md | 44 ----------- .../references/cli/installations/uninstall.md | 76 ------------------ .../references/cli/installations/upgrade.md | 73 ------------------ .../apply.md => installations_apply.md} | 0 .../delete.md => installations_delete.md} | 0 .../install.md => installations_install.md} | 34 ++++---- .../invoke.md => installations_invoke.md} | 33 ++++---- .../list.md => installations_list.md} | 17 ++-- .../logs.md => installations_logs.md} | 0 ...ogs_show.md => installations_logs_show.md} | 0 .../output.md => installations_output.md} | 0 ...t_list.md => installations_output_list.md} | 0 ...t_show.md => installations_output_show.md} | 0 .../runs.md => installations_runs.md} | 0 ...uns_list.md => installations_runs_list.md} | 0 .../show.md => installations_show.md} | 0 .../references/cli/installations_uninstall.md | 77 +++++++++++++++++++ .../references/cli/installations_upgrade.md | 74 ++++++++++++++++++ docs/content/docs/references/cli/invoke.md | 33 ++++---- docs/content/docs/references/cli/list.md | 17 ++-- docs/content/docs/references/cli/mixins.md | 37 +++++++++ .../docs/references/cli/mixins/_index.md | 35 --------- .../{mixins/create.md => mixins_create.md} | 0 .../cli/{mixins/feed.md => mixins_feed.md} | 0 ...ed_generate.md => mixins_feed_generate.md} | 4 +- ...ed_template.md => mixins_feed_template.md} | 0 .../{mixins/install.md => mixins_install.md} | 0 .../cli/{mixins/list.md => mixins_list.md} | 0 .../{mixins/search.md => mixins_search.md} | 0 .../uninstall.md => mixins_uninstall.md} | 0 .../content/docs/references/cli/parameters.md | 38 +++++++++ .../docs/references/cli/parameters/_index.md | 37 --------- .../docs/references/cli/parameters/create.md | 41 ---------- .../apply.md => parameters_apply.md} | 15 ++-- .../docs/references/cli/parameters_create.md | 44 +++++++++++ .../delete.md => parameters_delete.md} | 0 .../edit.md => parameters_edit.md} | 10 ++- .../generate.md => parameters_generate.md} | 0 .../list.md => parameters_list.md} | 0 .../show.md => parameters_show.md} | 0 .../cli/{plugins/_index.md => plugins.md} | 16 ++-- .../install.md => plugins_install.md} | 0 .../cli/{plugins/list.md => plugins_list.md} | 0 .../{plugins/search.md => plugins_search.md} | 0 .../cli/{plugins/show.md => plugins_show.md} | 0 .../uninstall.md => plugins_uninstall.md} | 0 docs/content/docs/references/cli/porter.md | 57 +++++++------- docs/content/docs/references/cli/publish.md | 1 + .../cli/{storage/_index.md => storage.md} | 0 ...missions.md => storage_fix-permissions.md} | 0 .../migrate.md => storage_migrate.md} | 2 +- docs/content/docs/references/cli/uninstall.md | 35 +++++---- docs/content/docs/references/cli/upgrade.md | 33 ++++---- magefile.go | 4 +- pkg/docs/generator.go | 2 +- 78 files changed, 593 insertions(+), 571 deletions(-) delete mode 100644 docs/content/docs/references/cli/_index.md create mode 100644 docs/content/docs/references/cli/bundles.md delete mode 100644 docs/content/docs/references/cli/bundles/_index.md rename docs/content/docs/references/cli/{bundles/archive.md => bundles_archive.md} (64%) rename docs/content/docs/references/cli/{bundles/build.md => bundles_build.md} (100%) rename docs/content/docs/references/cli/{bundles/copy.md => bundles_copy.md} (100%) rename docs/content/docs/references/cli/{bundles/create.md => bundles_create.md} (69%) rename docs/content/docs/references/cli/{bundles/explain.md => bundles_explain.md} (100%) rename docs/content/docs/references/cli/{bundles/inspect.md => bundles_inspect.md} (98%) rename docs/content/docs/references/cli/{bundles/lint.md => bundles_lint.md} (100%) create mode 100644 docs/content/docs/references/cli/credentials.md delete mode 100644 docs/content/docs/references/cli/credentials/_index.md rename docs/content/docs/references/cli/{credentials/apply.md => credentials_apply.md} (100%) rename docs/content/docs/references/cli/{credentials/create.md => credentials_create.md} (100%) rename docs/content/docs/references/cli/{credentials/delete.md => credentials_delete.md} (100%) rename docs/content/docs/references/cli/{credentials/edit.md => credentials_edit.md} (100%) rename docs/content/docs/references/cli/{credentials/generate.md => credentials_generate.md} (100%) rename docs/content/docs/references/cli/{credentials/list.md => credentials_list.md} (100%) rename docs/content/docs/references/cli/{credentials/show.md => credentials_show.md} (100%) create mode 100644 docs/content/docs/references/cli/installations.md delete mode 100644 docs/content/docs/references/cli/installations/_index.md delete mode 100644 docs/content/docs/references/cli/installations/uninstall.md delete mode 100644 docs/content/docs/references/cli/installations/upgrade.md rename docs/content/docs/references/cli/{installations/apply.md => installations_apply.md} (100%) rename docs/content/docs/references/cli/{installations/delete.md => installations_delete.md} (100%) rename docs/content/docs/references/cli/{installations/install.md => installations_install.md} (52%) rename docs/content/docs/references/cli/{installations/invoke.md => installations_invoke.md} (50%) rename docs/content/docs/references/cli/{installations/list.md => installations_list.md} (59%) rename docs/content/docs/references/cli/{installations/logs.md => installations_logs.md} (100%) rename docs/content/docs/references/cli/{installations/logs_show.md => installations_logs_show.md} (100%) rename docs/content/docs/references/cli/{installations/output.md => installations_output.md} (100%) rename docs/content/docs/references/cli/{installations/output_list.md => installations_output_list.md} (100%) rename docs/content/docs/references/cli/{installations/output_show.md => installations_output_show.md} (100%) rename docs/content/docs/references/cli/{installations/runs.md => installations_runs.md} (100%) rename docs/content/docs/references/cli/{installations/runs_list.md => installations_runs_list.md} (100%) rename docs/content/docs/references/cli/{installations/show.md => installations_show.md} (100%) create mode 100644 docs/content/docs/references/cli/installations_uninstall.md create mode 100644 docs/content/docs/references/cli/installations_upgrade.md create mode 100644 docs/content/docs/references/cli/mixins.md delete mode 100644 docs/content/docs/references/cli/mixins/_index.md rename docs/content/docs/references/cli/{mixins/create.md => mixins_create.md} (100%) rename docs/content/docs/references/cli/{mixins/feed.md => mixins_feed.md} (100%) rename docs/content/docs/references/cli/{mixins/feed_generate.md => mixins_feed_generate.md} (96%) rename docs/content/docs/references/cli/{mixins/feed_template.md => mixins_feed_template.md} (100%) rename docs/content/docs/references/cli/{mixins/install.md => mixins_install.md} (100%) rename docs/content/docs/references/cli/{mixins/list.md => mixins_list.md} (100%) rename docs/content/docs/references/cli/{mixins/search.md => mixins_search.md} (100%) rename docs/content/docs/references/cli/{mixins/uninstall.md => mixins_uninstall.md} (100%) create mode 100644 docs/content/docs/references/cli/parameters.md delete mode 100644 docs/content/docs/references/cli/parameters/_index.md delete mode 100644 docs/content/docs/references/cli/parameters/create.md rename docs/content/docs/references/cli/{parameters/apply.md => parameters_apply.md} (75%) create mode 100644 docs/content/docs/references/cli/parameters_create.md rename docs/content/docs/references/cli/{parameters/delete.md => parameters_delete.md} (100%) rename docs/content/docs/references/cli/{parameters/edit.md => parameters_edit.md} (79%) rename docs/content/docs/references/cli/{parameters/generate.md => parameters_generate.md} (100%) rename docs/content/docs/references/cli/{parameters/list.md => parameters_list.md} (100%) rename docs/content/docs/references/cli/{parameters/show.md => parameters_show.md} (100%) rename docs/content/docs/references/cli/{plugins/_index.md => plugins.md} (51%) rename docs/content/docs/references/cli/{plugins/install.md => plugins_install.md} (100%) rename docs/content/docs/references/cli/{plugins/list.md => plugins_list.md} (100%) rename docs/content/docs/references/cli/{plugins/search.md => plugins_search.md} (100%) rename docs/content/docs/references/cli/{plugins/show.md => plugins_show.md} (100%) rename docs/content/docs/references/cli/{plugins/uninstall.md => plugins_uninstall.md} (100%) rename docs/content/docs/references/cli/{storage/_index.md => storage.md} (100%) rename docs/content/docs/references/cli/{storage/fix-permissions.md => storage_fix-permissions.md} (100%) rename docs/content/docs/references/cli/{storage/migrate.md => storage_migrate.md} (95%) diff --git a/docs/content/docs/references/cli/_index.md b/docs/content/docs/references/cli/_index.md deleted file mode 100644 index 5aca45ff2..000000000 --- a/docs/content/docs/references/cli/_index.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Porter Commands" -date: 2023-09-10T01:55:46+05:30 -description: "" -weight: 2 ---- - -**All of the Porter Commands** - -{{< cards >}} -{{< card link="inspecting-bundles" title="Inspecting Bundles" >}} -{{< card link="copy-bundles" title="Copy Bundles" >}} -{{< card link="move-bundles-airgapped" title="Move Bundles Across Airgapped Environments" >}} -{{< card link="collect-diag-porter" title="Collect Diagnostics from Porter" >}} -{{< /cards >}} diff --git a/docs/content/docs/references/cli/archive.md b/docs/content/docs/references/cli/archive.md index 05f2c6d8e..2508a4914 100644 --- a/docs/content/docs/references/cli/archive.md +++ b/docs/content/docs/references/cli/archive.md @@ -20,16 +20,18 @@ porter archive FILENAME --reference PUBLISHED_BUNDLE [flags] ``` porter archive mybun.tgz --reference ghcr.io/getporter/examples/porter-hello:v0.2.0 porter archive mybun.tgz --reference localhost:5000/ghcr.io/getporter/examples/porter-hello:v0.2.0 --force + porter archive mybun.tgz --compression NoCompression --reference ghcr.io/getporter/examples/porter-hello:v0.2.0 ``` ### Options ``` - --force Force a fresh pull of the bundle - -h, --help help for archive - --insecure-registry Don't require TLS for the registry - -r, --reference string Use a bundle in an OCI registry specified by the given reference. + -c, --compression string Compression level to use when creating the gzipped tar archive. Allowed values are: BestCompression, BestSpeed, DefaultCompression, HuffmanOnly, NoCompression (default "DefaultCompression") + --force Force a fresh pull of the bundle + -h, --help help for archive + --insecure-registry Don't require TLS for the registry + -r, --reference string Use a bundle in an OCI registry specified by the given reference. ``` ### Options inherited from parent commands diff --git a/docs/content/docs/references/cli/bundles.md b/docs/content/docs/references/cli/bundles.md new file mode 100644 index 000000000..88b827184 --- /dev/null +++ b/docs/content/docs/references/cli/bundles.md @@ -0,0 +1,42 @@ +--- +title: "porter bundles" +slug: porter_bundles +url: /cli/porter_bundles/ +--- +## porter bundles + +Bundle commands + +### Synopsis + +Commands for working with bundles. These all have shortcuts so that you can call these commands without the bundle resource prefix. For example, porter bundle build is available as porter build as well. + +### Options + +``` + -h, --help help for bundles +``` + +### Options inherited from parent commands + +``` + --experimental strings Comma separated list of experimental features to enable. See https://porter.sh/configuration/#experimental-feature-flags for available feature flags. + --verbosity string Threshold for printing messages to the console. Available values are: debug, info, warning, error. (default "info") +``` + +### SEE ALSO + +* [porter](/cli/porter/) - With Porter you can package your application artifact, client tools, configuration and deployment logic together as a versioned bundle that you can distribute, and then install with a single command. + +Most commands require a Docker daemon, either local or remote. + +Try our QuickStart https://porter.sh/quickstart to learn how to use Porter. + +* [porter bundles archive](/cli/porter_bundles_archive/) - Archive a bundle from a reference +* [porter bundles build](/cli/porter_bundles_build/) - Build a bundle +* [porter bundles copy](/cli/porter_bundles_copy/) - Copy a bundle +* [porter bundles create](/cli/porter_bundles_create/) - Create a bundle +* [porter bundles explain](/cli/porter_bundles_explain/) - Explain a bundle +* [porter bundles inspect](/cli/porter_bundles_inspect/) - Inspect a bundle +* [porter bundles lint](/cli/porter_bundles_lint/) - Lint a bundle + diff --git a/docs/content/docs/references/cli/bundles/_index.md b/docs/content/docs/references/cli/bundles/_index.md deleted file mode 100644 index 1bb1563f2..000000000 --- a/docs/content/docs/references/cli/bundles/_index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: "Bundles" -weight: 2 ---- - -## Bundle Commands - -### Synopsis - -Commands for working with bundles. These all have shortcuts so that you can call these commands without the bundle resource prefix. For example, porter bundle build is available as porter build as well. - -### Options - -``` - -h, --help help for bundles -``` - -### Options inherited from parent commands - -``` - --experimental strings Comma separated list of experimental features to enable. See https://porter.sh/configuration/#experimental-feature-flags for available feature flags. - --verbosity string Threshold for printing messages to the console. Available values are: debug, info, warning, error. (default "info") -``` - -### SEE ALSO - -- [porter](/references/cli/porter/) - With Porter you can package your application artifact, client tools, configuration and deployment logic together as a versioned bundle that you can distribute, and then install with a single command. - -Most commands require a Docker daemon, either local or remote. - -Try our QuickStart https://porter.sh/quickstart to learn how to use Porter. - -- [porter bundles archive](/cli/porter_bundles_archive/) - Archive a bundle from a reference -- [porter bundles build](/cli/porter_bundles_build/) - Build a bundle -- [porter bundles copy](/cli/porter_bundles_copy/) - Copy a bundle -- [porter bundles create](/cli/porter_bundles_create/) - Create a bundle -- [porter bundles explain](/cli/porter_bundles_explain/) - Explain a bundle -- [porter bundles inspect](/cli/porter_bundles_inspect/) - Inspect a bundle -- [porter bundles lint](/cli/porter_bundles_lint/) - Lint a bundle diff --git a/docs/content/docs/references/cli/bundles/archive.md b/docs/content/docs/references/cli/bundles_archive.md similarity index 64% rename from docs/content/docs/references/cli/bundles/archive.md rename to docs/content/docs/references/cli/bundles_archive.md index f007f6a2b..485b998ab 100644 --- a/docs/content/docs/references/cli/bundles/archive.md +++ b/docs/content/docs/references/cli/bundles_archive.md @@ -20,16 +20,18 @@ porter bundles archive FILENAME --reference PUBLISHED_BUNDLE [flags] ``` porter bundle archive mybun.tgz --reference ghcr.io/getporter/examples/porter-hello:v0.2.0 porter bundle archive mybun.tgz --reference localhost:5000/ghcr.io/getporter/examples/porter-hello:v0.2.0 --force + porter bundle archive mybun.tgz --compression NoCompression --reference ghcr.io/getporter/examples/porter-hello:v0.2.0 ``` ### Options ``` - --force Force a fresh pull of the bundle - -h, --help help for archive - --insecure-registry Don't require TLS for the registry - -r, --reference string Use a bundle in an OCI registry specified by the given reference. + -c, --compression string Compression level to use when creating the gzipped tar archive. Allowed values are: BestCompression, BestSpeed, DefaultCompression, HuffmanOnly, NoCompression (default "DefaultCompression") + --force Force a fresh pull of the bundle + -h, --help help for archive + --insecure-registry Don't require TLS for the registry + -r, --reference string Use a bundle in an OCI registry specified by the given reference. ``` ### Options inherited from parent commands diff --git a/docs/content/docs/references/cli/bundles/build.md b/docs/content/docs/references/cli/bundles_build.md similarity index 100% rename from docs/content/docs/references/cli/bundles/build.md rename to docs/content/docs/references/cli/bundles_build.md diff --git a/docs/content/docs/references/cli/bundles/copy.md b/docs/content/docs/references/cli/bundles_copy.md similarity index 100% rename from docs/content/docs/references/cli/bundles/copy.md rename to docs/content/docs/references/cli/bundles_copy.md diff --git a/docs/content/docs/references/cli/bundles/create.md b/docs/content/docs/references/cli/bundles_create.md similarity index 69% rename from docs/content/docs/references/cli/bundles/create.md rename to docs/content/docs/references/cli/bundles_create.md index cb363e64c..19563cbbc 100644 --- a/docs/content/docs/references/cli/bundles/create.md +++ b/docs/content/docs/references/cli/bundles_create.md @@ -9,7 +9,7 @@ Create a bundle ### Synopsis -Create a bundle. This generates a porter bundle in the directory with the specified name or in the current directory if no name is provided. +Create a bundle. This command creates a new porter bundle with the specified bundle-name, in the directory with the specified bundle-name. The directory will be created if it doesn't already exist. If no bundle-name is provided, the bundle will be created in current directory and the bundle name will be 'porter-hello'. ``` porter bundles create [bundle-name] [flags] diff --git a/docs/content/docs/references/cli/bundles/explain.md b/docs/content/docs/references/cli/bundles_explain.md similarity index 100% rename from docs/content/docs/references/cli/bundles/explain.md rename to docs/content/docs/references/cli/bundles_explain.md diff --git a/docs/content/docs/references/cli/bundles/inspect.md b/docs/content/docs/references/cli/bundles_inspect.md similarity index 98% rename from docs/content/docs/references/cli/bundles/inspect.md rename to docs/content/docs/references/cli/bundles_inspect.md index 0a700e9ec..11a72098b 100644 --- a/docs/content/docs/references/cli/bundles/inspect.md +++ b/docs/content/docs/references/cli/bundles_inspect.md @@ -2,8 +2,6 @@ title: "porter bundles inspect" slug: porter_bundles_inspect url: /cli/porter_bundles_inspect/ -aliases: - - /inspect-bundles --- ## porter bundles inspect diff --git a/docs/content/docs/references/cli/bundles/lint.md b/docs/content/docs/references/cli/bundles_lint.md similarity index 100% rename from docs/content/docs/references/cli/bundles/lint.md rename to docs/content/docs/references/cli/bundles_lint.md diff --git a/docs/content/docs/references/cli/create.md b/docs/content/docs/references/cli/create.md index fb19d8b46..765ed886c 100644 --- a/docs/content/docs/references/cli/create.md +++ b/docs/content/docs/references/cli/create.md @@ -9,7 +9,7 @@ Create a bundle ### Synopsis -Create a bundle. This generates a porter bundle in the directory with the specified name or in the current directory if no name is provided. +Create a bundle. This command creates a new porter bundle with the specified bundle-name, in the directory with the specified bundle-name. The directory will be created if it doesn't already exist. If no bundle-name is provided, the bundle will be created in current directory and the bundle name will be 'porter-hello'. ``` porter create [bundle-name] [flags] diff --git a/docs/content/docs/references/cli/credentials.md b/docs/content/docs/references/cli/credentials.md new file mode 100644 index 000000000..2f0ab163d --- /dev/null +++ b/docs/content/docs/references/cli/credentials.md @@ -0,0 +1,38 @@ +--- +title: "porter credentials" +slug: porter_credentials +url: /cli/porter_credentials/ +--- +## porter credentials + +Credentials commands + +### Options + +``` + -h, --help help for credentials +``` + +### Options inherited from parent commands + +``` + --experimental strings Comma separated list of experimental features to enable. See https://porter.sh/configuration/#experimental-feature-flags for available feature flags. + --verbosity string Threshold for printing messages to the console. Available values are: debug, info, warning, error. (default "info") +``` + +### SEE ALSO + +* [porter](/cli/porter/) - With Porter you can package your application artifact, client tools, configuration and deployment logic together as a versioned bundle that you can distribute, and then install with a single command. + +Most commands require a Docker daemon, either local or remote. + +Try our QuickStart https://porter.sh/quickstart to learn how to use Porter. + +* [porter credentials apply](/cli/porter_credentials_apply/) - Apply changes to a credential set +* [porter credentials create](/cli/porter_credentials_create/) - Create a Credential +* [porter credentials delete](/cli/porter_credentials_delete/) - Delete a Credential +* [porter credentials edit](/cli/porter_credentials_edit/) - Edit Credential +* [porter credentials generate](/cli/porter_credentials_generate/) - Generate Credential Set +* [porter credentials list](/cli/porter_credentials_list/) - List credentials +* [porter credentials show](/cli/porter_credentials_show/) - Show a Credential + diff --git a/docs/content/docs/references/cli/credentials/_index.md b/docs/content/docs/references/cli/credentials/_index.md deleted file mode 100644 index a71284d10..000000000 --- a/docs/content/docs/references/cli/credentials/_index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: "Credentials" -weight: 3 ---- - -## Credentials Commands - -### Options - -``` - -h, --help help for credentials -``` - -### Options inherited from parent commands - -``` - --experimental strings Comma separated list of experimental features to enable. See https://porter.sh/configuration/#experimental-feature-flags for available feature flags. - --verbosity string Threshold for printing messages to the console. Available values are: debug, info, warning, error. (default "info") -``` - -### SEE ALSO - -- [porter](/cli/porter/) - With Porter you can package your application artifact, client tools, configuration and deployment logic together as a versioned bundle that you can distribute, and then install with a single command. - -Most commands require a Docker daemon, either local or remote. - -Try our QuickStart https://porter.sh/quickstart to learn how to use Porter. - -- [porter credentials apply](/cli/porter_credentials_apply/) - Apply changes to a credential set -- [porter credentials create](/cli/porter_credentials_create/) - Create a Credential -- [porter credentials delete](/cli/porter_credentials_delete/) - Delete a Credential -- [porter credentials edit](/cli/porter_credentials_edit/) - Edit Credential -- [porter credentials generate](/cli/porter_credentials_generate/) - Generate Credential Set -- [porter credentials list](/cli/porter_credentials_list/) - List credentials -- [porter credentials show](/cli/porter_credentials_show/) - Show a Credential diff --git a/docs/content/docs/references/cli/credentials/apply.md b/docs/content/docs/references/cli/credentials_apply.md similarity index 100% rename from docs/content/docs/references/cli/credentials/apply.md rename to docs/content/docs/references/cli/credentials_apply.md diff --git a/docs/content/docs/references/cli/credentials/create.md b/docs/content/docs/references/cli/credentials_create.md similarity index 100% rename from docs/content/docs/references/cli/credentials/create.md rename to docs/content/docs/references/cli/credentials_create.md diff --git a/docs/content/docs/references/cli/credentials/delete.md b/docs/content/docs/references/cli/credentials_delete.md similarity index 100% rename from docs/content/docs/references/cli/credentials/delete.md rename to docs/content/docs/references/cli/credentials_delete.md diff --git a/docs/content/docs/references/cli/credentials/edit.md b/docs/content/docs/references/cli/credentials_edit.md similarity index 100% rename from docs/content/docs/references/cli/credentials/edit.md rename to docs/content/docs/references/cli/credentials_edit.md diff --git a/docs/content/docs/references/cli/credentials/generate.md b/docs/content/docs/references/cli/credentials_generate.md similarity index 100% rename from docs/content/docs/references/cli/credentials/generate.md rename to docs/content/docs/references/cli/credentials_generate.md diff --git a/docs/content/docs/references/cli/credentials/list.md b/docs/content/docs/references/cli/credentials_list.md similarity index 100% rename from docs/content/docs/references/cli/credentials/list.md rename to docs/content/docs/references/cli/credentials_list.md diff --git a/docs/content/docs/references/cli/credentials/show.md b/docs/content/docs/references/cli/credentials_show.md similarity index 100% rename from docs/content/docs/references/cli/credentials/show.md rename to docs/content/docs/references/cli/credentials_show.md diff --git a/docs/content/docs/references/cli/install.md b/docs/content/docs/references/cli/install.md index 07ddf7f39..527cf9247 100644 --- a/docs/content/docs/references/cli/install.md +++ b/docs/content/docs/references/cli/install.md @@ -45,22 +45,24 @@ porter install [INSTALLATION] [flags] ### Options ``` - --allow-docker-host-access Controls if the bundle should have access to the host's Docker daemon with elevated privileges. See https://porter.sh/configuration/#allow-docker-host-access for the full implications of this flag. - --autobuild-disabled Do not automatically build the bundle from source when the last build is out-of-date. - --cnab-file string Path to the CNAB bundle.json file. - -c, --credential-set stringArray Credential sets to use when running the bundle. It should be a named set of credentials and may be specified multiple times. - --debug Run the bundle in debug mode. - -d, --driver string Specify a driver to use. Allowed values: docker, debug (default "docker") - -f, --file porter.yaml Path to the Porter manifest. Defaults to porter.yaml in the current directory. - --force Force a fresh pull of the bundle - -h, --help help for install - --insecure-registry Don't require TLS for the registry - -l, --label strings Associate the specified labels with the installation. May be specified multiple times. - -n, --namespace string Create the installation in the specified namespace. Defaults to the global namespace. - --no-logs Do not persist the bundle execution logs - --param stringArray Define an individual parameter in the form NAME=VALUE. Overrides parameters otherwise set via --parameter-set. May be specified multiple times. - -p, --parameter-set stringArray Parameter sets to use when running the bundle. It should be a named set of parameters and may be specified multiple times. - -r, --reference string Use a bundle in an OCI registry specified by the given reference. + --allow-docker-host-access Controls if the bundle should have access to the host's Docker daemon with elevated privileges. See https://porter.sh/configuration/#allow-docker-host-access for the full implications of this flag. + --autobuild-disabled Do not automatically build the bundle from source when the last build is out-of-date. + --cnab-file string Path to the CNAB bundle.json file. + -c, --credential-set stringArray Credential sets to use when running the bundle. It should be a named set of credentials and may be specified multiple times. + --debug Run the bundle in debug mode. + -d, --driver string Specify a driver to use. Allowed values: docker, debug (default "docker") + -f, --file porter.yaml Path to the Porter manifest. Defaults to porter.yaml in the current directory. + --force Force a fresh pull of the bundle + -h, --help help for install + --insecure-registry Don't require TLS for the registry + -l, --label strings Associate the specified labels with the installation. May be specified multiple times. + --mount-host-volume stringArray Mount a host volume into the bundle. Format is :[: