### Example Installation Commands Source: https://github.com/replicatedhq/replicated-docs/blob/main/static/enterprise/installing-existing-cluster.md Provides concrete examples of the commands to install an application, both for the latest version and a specific version using a label. ```shell curl https://kots.io/install | bash kubectl kots install application-name ``` ```shell curl https://kots.io/install | bash kubectl kots install application-name --app-version-label=3.0.1 ``` -------------------------------- ### Example KOTS Installation Prompt Source: https://github.com/replicatedhq/replicated-docs/blob/main/static/enterprise/installing-existing-cluster-airgapped.md This is an example of the interactive prompts you will encounter during the `kubectl kots install` command. It shows the expected input for the deployment namespace and the Admin Console password. ```shell $$ kubectl kots install application-name Enter the namespace to deploy to: application-name • Deploying Admin Console • Creating namespace ✓ • Waiting for datastore to be ready ✓ Enter a new password to be used for the Admin Console: •••••••• • Waiting for Admin Console to be ready ✓ • Press Ctrl+C to exit ``` -------------------------------- ### Example KOTS Install Command Prompts Source: https://github.com/replicatedhq/replicated-docs/blob/main/static/vendor/tutorial-preflight-helm-install-kots.md This example shows the expected prompts and responses when installing the KOTS CLI and Admin Console. It includes setting the deployment namespace and creating an Admin Console password. The output provides the URL to access the Admin Console. ```bash Enter the namespace to deploy to: gitea • Deploying Admin Console • Creating namespace ✓ • Waiting for datastore to be ready ✓ Enter a new password for the Admin Console (6+ characters): •••••••• • Waiting for Admin Console to be ready ✓ • Press Ctrl+C to exit • Go to http://localhost:8800 to access the Admin Console ``` -------------------------------- ### Example: Install Specific Application Version with KOTS CLI Source: https://github.com/replicatedhq/replicated-docs/blob/main/docs/enterprise/installing-existing-cluster.mdx Provides an example of installing a specific application version (3.0.1) named 'application-name' using the KOTS CLI. ```shell curl https://kots.io/install | bash kubectl kots install application-name --app-version-label=3.0.1 ``` -------------------------------- ### Example Embedded Cluster Installation Output (Bash) Source: https://github.com/replicatedhq/replicated-docs/blob/main/docs/enterprise/installing-embedded.mdx This is an example of the output you might see during the Embedded Cluster installation process. It indicates successful completion of various stages and provides the URL for the Admin Console. ```bash ? Enter an Admin Console password: ******** ? Confirm password: ******** ✔ Host files materialized! ✔ Running host preflights ✔ Node installation finished! ✔ Storage is ready! ✔ Embedded Cluster Operator is ready! ✔ Admin Console is ready! ✔ Additional components are ready! Visit the Admin Console to configure and install gitea-kite: http://104.155.145.60:30000 ``` -------------------------------- ### Example: Install Application with KOTS CLI Source: https://github.com/replicatedhq/replicated-docs/blob/main/docs/enterprise/installing-existing-cluster.mdx Demonstrates the command to install an application named 'application-name' using the KOTS CLI, assuming the latest version. ```shell curl https://kots.io/install | bash kubectl kots install application-name ``` -------------------------------- ### KOTS CLI Installation Examples Source: https://github.com/replicatedhq/replicated-docs/blob/main/docs/reference/kots-cli-install.mdx Demonstrates common usage patterns for installing applications using the KOTS CLI, including specifying license files, passwords, namespaces, and configuration values. ```bash kubectl kots install sentry/unstable --license-file ~/license.yaml kubectl kots install kots-sentry/stable --shared-password IgqG5OBc9Gp --license-file ~/sentry-license.yaml --namespace sentry-namespace --config-values ~/config-values.yaml kubectl kots install --ensure-rbac=false ``` -------------------------------- ### Example KOTS Install Command Output Source: https://github.com/replicatedhq/replicated-docs/blob/main/docs/enterprise/installing-existing-cluster-automation.mdx This output demonstrates a successful installation process using the `kots install` command, showing the deployment of the Admin Console and completion of preflight checks. ```text • Deploying Admin Console • Creating namespace ✓ • Waiting for datastore to be ready ✓ • Waiting for Admin Console to be ready ✓ • Waiting for installation to complete ✓ • Waiting for preflight checks to complete ✓ • Press Ctrl+C to exit • Go to http://localhost:8800 to access the Admin Console • Go to http://localhost:8888 to access the application ``` -------------------------------- ### Interactive Installation Prompt and Port Forward Example Source: https://github.com/replicatedhq/replicated-docs/blob/main/static/enterprise/installing-existing-cluster.md Demonstrates the interactive prompts during `kots install`, including namespace selection and password creation, and shows how to access the Admin Console via port forward. ```shell $ kubectl kots install application-name Enter the namespace to deploy to: application-name • Deploying Admin Console • Creating namespace ✓ • Waiting for datastore to be ready ✓ Enter a new password to be used for the Admin Console: •••••••• • Waiting for Admin Console to be ready ✓ • Press Ctrl+C to exit • Go to http://localhost:8800 to access the Admin Console ``` -------------------------------- ### Example kots install Command and Prompts Source: https://github.com/replicatedhq/replicated-docs/blob/main/docs/partials/install/_kots-install-prompts.mdx Demonstrates the usage of the `kubectl kots install` command and the interactive prompts for specifying the installation namespace and setting a password for the Admin Console. It also shows the output indicating successful deployment and how to access the Admin Console. ```shell $ kubectl kots install application-name Enter the namespace to deploy to: application-name • Deploying Admin Console • Creating namespace ✓ • Waiting for datastore to be ready ✓ Enter a new password to be used for the Admin Console: •••••••• • Waiting for Admin Console to be ready ✓ • Press Ctrl+C to exit • Go to http://localhost:8800 to access the Admin Console ``` -------------------------------- ### Example: Log in to Replicated Registry Source: https://github.com/replicatedhq/replicated-docs/blob/main/docs/vendor/preflight-running.md An example of logging into the Replicated registry using a customer's email as the username and their license ID as the password. ```bash helm registry login registry.replicated.com --username example@companyname.com password 1234abcd ``` -------------------------------- ### Example kURL Installation Output Source: https://github.com/replicatedhq/replicated-docs/blob/main/docs/vendor/kurl-about.mdx This snippet shows the expected output from the kURL installation script after a successful installation. It provides the URL to access the KOTS Admin Console and the initial login password. ```bash Installation Complete ✔ Kotsadm: http://10.128.0.35:8800 Login with password (will not be shown again): 3Hy8WYYid This password has been set for you by default. It is recommended that you change this password; this can be done with the following command: kubectl kots reset-password default ``` -------------------------------- ### Example: Enable Airgap Installations for a Customer Source: https://github.com/replicatedhq/replicated-docs/blob/main/docs/reference/replicated-cli-customer-update.mdx Illustrates enabling the 'airgap' installation option for a customer's license, allowing them to perform airgapped deployments. ```bash replicated customer update --customer cus_abcdef123456 --airgap ``` -------------------------------- ### Docusaurus Sidebar Configuration (JavaScript) Source: https://context7.com/replicatedhq/replicated-docs/llms.txt Defines the structure and hierarchy of the documentation's navigation sidebar. It organizes content into categories like release notes, getting started guides, and reference materials. ```javascript // sidebars.js const sidebars = { main: [ 'intro', { type: 'category', label: 'Release Notes', items: [ 'release-notes/rn-whats-new', 'release-notes/rn-embedded-cluster', 'release-notes/rn-app-manager', 'release-notes/rn-kubernetes-installer', ], }, // HTML divider for section headings { type: 'html', value: '
Get started
', defaultStyle: true }, 'intro-replicated', 'vendor/kots-faq', 'vendor/quick-start', // Nested categories { type: 'category', label: 'Embedded Cluster', items: [ 'vendor/embedded-overview', 'enterprise/installing-embedded', 'enterprise/embedded-manage-nodes', ], }, // Collapsible categories with subcategories { type: 'category', label: 'Reference', collapsible: true, collapsed: false, items: [ { type: 'category', label: 'KOTS CLI', items: ['reference/kots-cli-getting-started'], }, { type: 'category', label: 'Replicated CLI', items: ['reference/replicated-cli-installing'], }, ], }, ], }; module.exports = sidebars; ``` -------------------------------- ### Create and Navigate to Tutorial Directory Source: https://github.com/replicatedhq/replicated-docs/blob/main/static/vendor/tutorial-cli-manifests.md Creates a new directory named 'replicated-cli-tutorial' and changes the current working directory into it. This is the initial setup for the tutorial's files. ```bash mkdir replicated-cli-tutorial cd replicated-cli-tutorial ``` -------------------------------- ### Install Velero on Azure with Specific Flags Source: https://github.com/replicatedhq/replicated-docs/blob/main/docs/enterprise/snapshots-storage-destinations.md This example demonstrates installing Velero and configuring an Azure storage destination. It specifies flags for Velero 1.10 and later, including `--use-node-agent`, `--uploader-type=restic`, and `--use-volume-snapshots=false`, and alternative flags for older versions. The `backup-location-config` and `snapshot-location-config` parameters are crucial for Azure setup. ```bash velero install \ --provider azure \ --plugins velero/velero-plugin-for-microsoft-azure:v1.5.0 \ --bucket $BLOB_CONTAINER \ --secret-file ./CREDS_FILE \ --backup-location-config resourceGroup=$AZURE_BACKUP_RESOURCE_GROUP,storageAccount=$AZURE_STORAGE_ACCOUNT_ID[,subscriptionId=$AZURE_BACKUP_SUBSCRIPTION_ID] \ --snapshot-location-config apiTimeout=[,resourceGroup=$AZURE_BACKUP_RESOURCE_GROUP,subscriptionId=$AZURE_BACKUP_SUBSCRIPTION_ID] \ --use-node-agent --uploader-type=restic \ --use-volume-snapshots=false ``` -------------------------------- ### Install Preflight and Support Bundle Plugins (Windows/Linux via Krew) Source: https://github.com/replicatedhq/replicated-docs/blob/main/docs/vendor/environment-setup.mdx Installs the preflight and support-bundle plugins using Krew after Krew has been installed. These plugins are essential for troubleshooting Replicated applications. ```bash kubectl krew install preflight kubectl krew install support-bundle ``` -------------------------------- ### Example Deployment Output Source: https://github.com/replicatedhq/replicated-docs/blob/main/docs/vendor/replicated-sdk-installing.mdx Sample output from 'kubectl get deploy' command, showing the 'replicated' deployment along with other Kubernetes resources. ```text NAME READY UP-TO-DATE AVAILABLE AGE kotsadm 1/1 1 1 112s my-app 1/1 1 1 28s replicated 1/1 1 1 27s ``` -------------------------------- ### Get Installed Apps using kots CLI Source: https://github.com/replicatedhq/replicated-docs/blob/main/static/reference/kots-cli-get-apps.md The `kots get apps` command lists installed applications. It requires the `--namespace` flag to specify the namespace where the KOTS Admin Console is running. No other flags are mandatory for basic usage. ```bash kubectl kots get apps -n ``` -------------------------------- ### Example: Create a 'kind' Cluster (CLI) Source: https://github.com/replicatedhq/replicated-docs/blob/main/docs/vendor/testing-how-to.md Provides a practical example of creating a 'kind' cluster using the Replicated CLI with specific Kubernetes version, disk size, and instance type. This demonstrates how to apply the advanced configuration options. ```bash replicated cluster create --name kind-example --distribution kind --version 1.27.0 --disk 100 --instance-type r1.small ``` -------------------------------- ### Helm CLI Annotation Example Source: https://github.com/replicatedhq/replicated-docs/blob/main/static/vendor/licenses-install-types.md This example demonstrates the use of the `kots.io/installer-only` annotation in Kubernetes resources for the Helm CLI installation type. This annotation signifies that a resource is exclusively used by Replicated installers and should not be managed by Helm directly. ```yaml apiVersion: v1 kind: Service metadata: name: my-service annotations: kots.io/installer-only: "true" ``` -------------------------------- ### Install Replicated CLI with Homebrew Source: https://github.com/replicatedhq/replicated-docs/blob/main/docs/partials/replicated-cli/_install-mac.mdx Installs the Replicated CLI using the Homebrew package manager. This is a straightforward method for macOS users. Ensure Homebrew is installed before running this command. ```shell brew install replicatedhq/replicated/cli ``` -------------------------------- ### Get Application Deployment Sequence using Sequence Source: https://github.com/replicatedhq/replicated-docs/blob/main/docs/reference/template-functions-license-context.md The Sequence function returns the current deployment sequence number of the application. This number increments with each application update, configuration change, license update, or registry setting modification, starting from 0 for each new installation. ```go func Sequence() int64 ``` ```yaml '{{repl Sequence }}' ``` -------------------------------- ### Start Local Development Server with npm Source: https://github.com/replicatedhq/replicated-docs/blob/main/README.md Starts a local development server to preview documentation changes live. Changes are reflected without restarting the server, except for sidebar modifications. ```bash npm start ``` -------------------------------- ### List Downloaded Manifest Files Source: https://github.com/replicatedhq/replicated-docs/blob/main/static/vendor/tutorial-cli-manifests.md Lists the files within the 'manifests' directory to verify that the sample Kubernetes manifest files were successfully downloaded and extracted. This confirms the setup for the next steps in the tutorial. ```bash ls manifests/ ``` -------------------------------- ### Example of Updating SDK Helm Chart Name Source: https://github.com/replicatedhq/replicated-docs/blob/main/docs/release-notes/rn-replicated-sdk.md This example demonstrates updating the Helm installation command to use the new `replicated` naming convention for the SDK chart. It specifies the chart name and version for installation. ```bash helm install replicated oci://registry.replicated.com/library/replicated --version 1.0.0-beta.6 ``` -------------------------------- ### List Installed Applications using kubectl kots get apps Source: https://github.com/replicatedhq/replicated-docs/blob/main/docs/reference/kots-cli-get-apps.md The `kubectl kots get apps` command retrieves a list of all applications currently installed and managed by KOTS. It requires the namespace where the Admin Console is running. No specific output format is defined beyond the standard CLI output. ```bash kubectl kots get apps [flags] ``` ```bash kubectl kots get apps -n default ``` -------------------------------- ### Install Replicated CLI Source: https://github.com/replicatedhq/replicated-docs/blob/main/static/llms.txt This topic provides instructions on how to install and run the Replicated CLI. The CLI is a powerful tool for interacting with the Replicated platform, managing releases, and performing various operational tasks. ```bash curl -sSL https://get.replicated.com/cli | sudo bash -s -- -d /usr/local/bin ``` -------------------------------- ### Install kURL in Airgap Mode (High Availability) Source: https://github.com/replicatedhq/replicated-docs/blob/main/static/enterprise/installing-kurl-airgap.md Run this command to install an application in airgap mode with kURL for a high availability (HA) setup. It includes the 'ha' argument for the installation script. ```bash cat install.sh | sudo bash -s airgap ha ``` -------------------------------- ### Rook Add-on Example Configuration (YAML) Source: https://github.com/replicatedhq/replicated-docs/blob/main/docs/vendor/packaging-installer-storage.mdx An example of a kURL Installer resource configuration specifying the Rook add-on version and storage class settings. This configuration is used to enable and customize the Rook add-on within a kURL installation. It requires Rook version 1.7.x and disables shared filesystems. ```yaml apiVersion: "cluster.kurl.sh/v1beta1" kind: "Installer" metadata: name: "distributed" spec: ... rook: version: "1.7.x" storageClassName: "distributed" isSharedFilesystemDisabled: true ``` -------------------------------- ### Install Preflight and Support Bundle Plugins (Mac) Source: https://github.com/replicatedhq/replicated-docs/blob/main/docs/vendor/environment-setup.mdx Installs the preflight and support-bundle plugins using Homebrew for macOS users. These tools aid in troubleshooting by allowing preflight checks and support bundle collection. ```bash brew install preflight brew install support-bundle ``` -------------------------------- ### KOTS CLI Installation with Basic Options Source: https://github.com/replicatedhq/replicated-docs/blob/main/static/reference/kots-cli-install.md Basic installation of an application using the KOTS CLI. Requires specifying the application name and a license file. ```bash kubectl kots install sentry/unstable --license-file ~/license.yaml ``` -------------------------------- ### Manually Install Replicated CLI Source: https://github.com/replicatedhq/replicated-docs/blob/main/docs/partials/replicated-cli/_install-mac.mdx Installs the Replicated CLI by downloading the latest release directly from GitHub. This method involves fetching the tarball, extracting the binary, and placing it in the user's PATH. It is suitable for systems without Homebrew or for specific platform installations. ```shell curl -Ls $(curl -s https://api.github.com/repos/replicatedhq/replicated/releases/latest \ | grep "browser_download_url.*darwin_all.tar.gz" \ | cut -d : -f 2,3 \ | tr -d \") -o replicated.tar.gz tar xf replicated.tar.gz replicated && rm replicated.tar.gz mv replicated /usr/local/bin/replicated ``` -------------------------------- ### KOTS CLI Installation with RBAC Disabled Source: https://github.com/replicatedhq/replicated-docs/blob/main/static/reference/kots-cli-install.md Example of installing an application while explicitly disabling RBAC (Role-Based Access Control) checks. Use with caution as it may impact security. ```bash kubectl kots install --ensure-rbac=false ``` -------------------------------- ### Install {app.name} via Embedded Cluster on Linux (Online with Proxy) Source: https://github.com/replicatedhq/replicated-docs/blob/main/docs/vendor/enterprise-portal-configure.mdx Instructions for installing {app.name} on a Linux server online, utilizing a proxy. This method requires downloading the installation assets via the specified proxy URL, extracting them, and then running the installer with the license and HTTPS proxy configuration. ```shell curl -f "https://replicated.app/embedded/${app.slug}/${channel.channelSlug}/${release.versionLabel}" \ -H "Authorization: YOUR_LICENSE" \ --proxy \ -o ${app.slug}-${channel.channelSlug}.tgz ``` ```shell tar -xvzf ${app.slug}-${channel.channelSlug}.tgz ``` ```shell sudo ./${app.slug} install --license license.yaml --https-proxy= ``` ```shell sudo journalctl -u ${app.slug} ```