-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2379 from replicatedhq/kotsadm-ns-rm
Clarify usage of kotsadm namespace
- Loading branch information
Showing
16 changed files
with
340 additions
and
208 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 2 additions & 0 deletions
2
...ise/snapshots-velero-installing-config.md → ...se/snapshots-velero-installing-config.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| <tr> | ||
| <td><code>--kotsadm-namespace</code></td> | ||
| <td>string</td> | ||
| <td>Overrides the namespace of Admin Console images. Used for air gap installations.</td> | ||
| <td><p>Set to override the registry namespace of KOTS Admin Console images. Used for air gap installations. For more information, see [Air Gap Installation in Existing Clusters](/enterprise/installing-existing-cluster-airgapped).</p><p><strong>Note:</strong> Replicated recommends that you use <code>--kotsadm-registry</code> instead of <code>--kotsadm-namespace</code> to override both the registry hostname and, optionally, the registry namespace with a single flag.</p></td> | ||
| </tr> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| <tr> | ||
| <td><code>--kotsadm-registry</code></td> | ||
| <td>string</td> | ||
| <td>Overrides the registry of Admin Console images. Used for air gap installations.</td> | ||
| <td>Set to override the registry hostname and namespace of KOTS Admin Console images. Used for air gap installations. For more information, see [Air Gap Installation in Existing Clusters](/enterprise/installing-existing-cluster-airgapped).</td> | ||
| </tr> |
39 changes: 0 additions & 39 deletions
39
docs/reference/kots-cli-admin-console-generate-manifests.md
This file was deleted.
Oops, something went wrong.
85 changes: 85 additions & 0 deletions
85
docs/reference/kots-cli-admin-console-generate-manifests.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| import KotsadmNamespace from "../partials/kots-cli/_kotsadm-namespace.mdx" | ||
| import KotsadmRegistry from "../partials/kots-cli/_kotsadm-registry.mdx" | ||
| import RegistryPassword from "../partials/kots-cli/_registry-password.mdx" | ||
| import RegistryUsername from "../partials/kots-cli/_registry-username.mdx" | ||
|
|
||
| # admin-console generate-manifests | ||
|
|
||
| Running this command will create a directory on the workstation containing the Replicated Admin Console manifests. These assets can be used to deploy KOTS to a cluster through other workflows, such as kubectl, to provide additional customization of the Admin Console before deploying. | ||
|
|
||
| ### Limitations | ||
|
|
||
| `generate-manifests` does not support generating manifests for Red Hat OpenShift clusters or GKE Autopilot clusters if executed without a Kubernetes cluster context. | ||
|
|
||
| To upgrade a KOTS instance that has ever been on version 1.72.0 or earlier, you must run `generate-manifests` with a Kubernetes cluster context. | ||
|
|
||
| ### Usage | ||
| ```bash | ||
| kubectl kots admin-console generate-manifests [flags] | ||
| ``` | ||
|
|
||
| This command supports the following flags: | ||
|
|
||
| <table> | ||
| <tr> | ||
| <td>Flag</td> | ||
| <td>Type</td> | ||
| <td>Description</td> | ||
| </tr> | ||
| <tr> | ||
| <td><code>--rootdir</code></td> | ||
| <td>string</td> | ||
| <td>Root directory where the YAML will be written (default `${HOME}` or `%USERPROFILE%`)</td> | ||
| </tr> | ||
| <tr> | ||
| <td><code>--namespace</code></td> | ||
| <td>string</td> | ||
| <td>Target namespace for the Admin Console</td> | ||
| </tr> | ||
| <tr> | ||
| <td><code>--shared-password</code></td> | ||
| <td>string</td> | ||
| <td>Shared password to use when deploying the Admin Console</td> | ||
| </tr> | ||
| <tr> | ||
| <td><code>--http-proxy</code></td> | ||
| <td>string</td> | ||
| <td>Sets HTTP_PROXY environment variable in all KOTS Admin Console components</td> | ||
| </tr> | ||
| <tr> | ||
| <td><code>--http-proxy</code></td> | ||
| <td>string</td> | ||
| <td>Sets HTTP_PROXY environment variable in all KOTS Admin Console</td> | ||
| </tr> | ||
| <KotsadmNamespace/> | ||
| <KotsadmRegistry/> | ||
| <tr> | ||
| <td><code>--no-proxy</code></td> | ||
| <td>string</td> | ||
| <td>Sets NO_PROXY environment variable in all KOTS Admin Console components</td> | ||
| </tr> | ||
| <RegistryPassword/> | ||
| <RegistryUsername/> | ||
| <tr> | ||
| <td><code>--with-minio</code></td> | ||
| <td>bool</td> | ||
| <td>Set to true to include a local minio instance to be used for storage (default true)</td> | ||
| </tr> | ||
| <tr> | ||
| <td><code>--minimal-rbac</code></td> | ||
| <td>bool</td> | ||
| <td>Set to true to include a local minio instance to be used for storage (default true)</td> | ||
| </tr> | ||
| <tr> | ||
| <td><code>--additional-namespaces</code></td> | ||
| <td>string</td> | ||
| <td>Comma delimited list to specify additional namespace(s) managed by KOTS outside where it is to be deployed. Ignored without with <code>--minimal-rbac=true</code></td> | ||
| </tr> | ||
| </table> | ||
|
|
||
| ### Examples | ||
| ```bash | ||
| kubectl kots admin-console generate-manifests | ||
| kubectl kots admin-console generate-manifests --rootdir ./manifests | ||
| kubectl kots admin-console generate-manifests --namespace kotsadm --minimal-rbac=true --additional-namespaces="app1,app3" | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.