diff --git a/docs/enterprise/installing-existing-cluster-automation.mdx b/docs/enterprise/installing-existing-cluster-automation.mdx index 786864e9fb..1e82acb2ef 100644 --- a/docs/enterprise/installing-existing-cluster-automation.mdx +++ b/docs/enterprise/installing-existing-cluster-automation.mdx @@ -41,7 +41,7 @@ One common use case for installing with the CLI is to automate installation, suc For more information about the advanced options for the `kots install` command, see [install](/reference/kots-cli-install) in the KOTS CLI documentation. -For a tutorial that demonstrates how to install a sample application using the KOTS CLI, see [KOTS Tutorial (CLI)](/vendor/tutorial-cli-setup). +For a tutorial that demonstrates how to install a sample application using the KOTS CLI, see [Install with KOTS in an Existing Cluster](/vendor/tutorial-cli-setup). ## Limitation diff --git a/docs/vendor/distributing-workflow.md b/docs/vendor/distributing-workflow.md index 23f49589a0..23f05aeb63 100644 --- a/docs/vendor/distributing-workflow.md +++ b/docs/vendor/distributing-workflow.md @@ -17,7 +17,7 @@ If you are new to Replicated, complete the following prerequisites before you ge Packaging your application with Helm is recommended because it allows you to support both installations with the Helm CLI and with KOTS from the same release, without having to maintain separate sets of Helm charts or application manifests. ::: - * Alternatively, if you do _not_ intend to distribute a Helm chart-based application with Replicated, see [KOTS Tutorial (UI)](tutorial-ui-setup) for a workflow that uses a sample application with standard Kubernetes manifests. + * Alternatively, if you do _not_ intend to distribute a Helm application with Replicated, see [Install with KOTS in an Existing Cluster](tutorial-cli-setup) for a workflow that uses a sample application with Kubernetes manifests. ## Add Custom Resources diff --git a/docs/vendor/helm-native-about.mdx b/docs/vendor/helm-native-about.mdx index 7d78cff11b..e46a14e9cd 100644 --- a/docs/vendor/helm-native-about.mdx +++ b/docs/vendor/helm-native-about.mdx @@ -36,7 +36,7 @@ Additionally, for applications packaged as Helm charts, you can support Helm CLI [View a larger version of this image](/images/helm-kots-install-options.png) -For a tutorial that demonstrates how to add a sample Helm chart to a release and then install the release using both KOTS and the Helm CLI, see [Deploy a Helm Chart with KOTS and the Helm CLI](/vendor/tutorial-kots-helm-setup). +For a tutorial that demonstrates how to add a sample Helm chart to a release and then install the release using both KOTS and the Helm CLI, see [Install a Helm Chart with KOTS and the Helm CLI](/vendor/tutorial-kots-helm-setup). ## How KOTS Deploys Helm Charts diff --git a/docs/vendor/kots-faq.mdx b/docs/vendor/kots-faq.mdx index bf1c443245..2c4fab10a3 100644 --- a/docs/vendor/kots-faq.mdx +++ b/docs/vendor/kots-faq.mdx @@ -95,7 +95,7 @@ The UI-based installation experience of KOTS can provide an easier installation Yes. Software vendors that distribute their application as one or more Helm charts can support installations with both the Helm CLI and with KOTS from the same release. -For a tutorial that demonstrates how to add the Bitnami Gitea Helm chart to a release in the Replicated Vendor Portal and then install with both KOTS and the Helm CLI, see [Deploy a Helm Chart with KOTS and Helm CLI](/vendor/tutorial-kots-helm-setup). +For a tutorial that demonstrates how to add the Bitnami Gitea Helm chart to a release in the Replicated Vendor Portal and then install with both KOTS and the Helm CLI, see [Install a Helm Chart with KOTS and Helm CLI](/vendor/tutorial-kots-helm-setup). ### How does the Replicated SDK work with KOTS? diff --git a/docs/vendor/replicated-onboarding.mdx b/docs/vendor/replicated-onboarding.mdx index ed46f3fe5a..0982e19fa6 100644 --- a/docs/vendor/replicated-onboarding.mdx +++ b/docs/vendor/replicated-onboarding.mdx @@ -63,7 +63,7 @@ Before you begin, complete the following prerequisites: ``` :::note - If you do not intend to distribute a Helm chart-based application with Replicated, see [KOTS Tutorial (UI)](tutorial-ui-setup) to follow an onboarding workflow that uses a sample application with standard Kubernetes manifests and demonstrates installing with Replicated KOTS. + If you do not intend to distribute a Helm application with Replicated, see [Install with KOTS in an Existing Cluster](tutorial-cli-setup) to follow an onboarding workflow that uses a sample application with Kubernetes manifests and demonstrates installing with Replicated KOTS. ::: * You must have kubectl access to a cluster where you can develop against the Helm chart. Replicated recommends that you confirm that you can successfully install the chart in the cluster and also log in to the application UI. After you confirm that you can install and access the application, uninstall it before proceeding to the onboarding workflow. For more information, see [Helm Install](https://helm.sh/docs/helm/helm_install/) and [Helm Uninstall](https://helm.sh/docs/helm/helm_uninstall/) in the Helm documentation. diff --git a/docs/vendor/tutorial-adding-db-config.md b/docs/vendor/tutorial-adding-db-config.md index fe51c78981..0676be88e2 100644 --- a/docs/vendor/tutorial-adding-db-config.md +++ b/docs/vendor/tutorial-adding-db-config.md @@ -16,9 +16,7 @@ It is split into 5 sections: This guide assumes you have: -* A running instance of the Replicated Admin Console (`kotsadm`) to iterate against in either an existing cluster or an embedded cluster created with Replicated kURL. If you do not have a running instance of the Admin Console in an existing or embedded kURL cluster, complete one of the following getting started tutorials to package and install a sample application: - * [UI Tutorial](tutorial-ui-setup) - * [CLI Tutorial](tutorial-cli-setup) +* A running instance of the Replicated Admin Console (`kotsadm`) to iterate against in either an existing cluster or an embedded cluster created with Replicated kURL. If you do not have a running instance of the Admin Console in an existing or embedded kURL cluster, complete the [Install with KOTS in an Existing Cluster](tutorial-cli-setup) tutorial to package and install a sample application. * A local git checkout of your application manifests. ### Accompanying Code Examples diff --git a/docs/vendor/tutorial-ci-cd-integration.md b/docs/vendor/tutorial-ci-cd-integration.md index 9b937eee33..765efa7982 100644 --- a/docs/vendor/tutorial-ci-cd-integration.md +++ b/docs/vendor/tutorial-ci-cd-integration.md @@ -8,7 +8,7 @@ For a similar workflow that uses GitHub Actions, see [Replicated Kubernetes Star ## Environment Variables -This section will assume you already have the App slug and API token from the [CLI Tutorial](tutorial-cli-setup). +This section will assume you already have the App slug and API token from the [Install with KOTS in an Existing Cluster](tutorial-cli-setup) tutorial. - Configure the following 2 environment variables in your CI/CD configuration. diff --git a/docs/vendor/tutorial-cli-install-cli.mdx b/docs/vendor/tutorial-cli-install-cli.mdx index 2d3a1a9340..1eb0f60aea 100644 --- a/docs/vendor/tutorial-cli-install-cli.mdx +++ b/docs/vendor/tutorial-cli-install-cli.mdx @@ -1,6 +1,6 @@ # Step 1: Install the Replicated CLI -In this tutorial, you use the Replicated CLI to create and promote releases for a sample application with Replicated. The Replicated CLI is the CLI for the Replicated Vendor Portal. For a tutorial that uses the Replicated Vendor Portal UI to create and promote releases, see [UI Tutorial](tutorial-ui-setup). +In this tutorial, you use the Replicated CLI to create and promote releases for a sample application with Replicated. The Replicated CLI is the CLI for the Replicated Vendor Portal. This procedure describes how to create a Vendor Portal account, install the Replicated CLI on your local machine, and set up a `REPLICATED_API_TOKEN` environment variable for authentication. diff --git a/docs/vendor/tutorial-cli-setup.mdx b/docs/vendor/tutorial-cli-setup.mdx index 7cda3d2788..ac42bab465 100644 --- a/docs/vendor/tutorial-cli-setup.mdx +++ b/docs/vendor/tutorial-cli-setup.mdx @@ -10,8 +10,6 @@ import VMRequirements from "../partials/getting-started/_vm-requirements.mdx" The steps in this KOTS CLI-based tutorial show you how to use the Replicated CLI to perform these tasks. The Replicated CLI is the CLI for the Replicated Vendor Portal. You can use the Replicated CLI as a software vendor to programmatically create, configure, and manage your application artifacts, including application releases, release channels, customer entitlements, private image registries, and more. -For a tutorial that demonstrates how to use the Vendor Portal to create and promote releases for your application, see [UI Tutorial](tutorial-ui-setup). - ## Set Up the Environment diff --git a/docs/vendor/tutorial-ecr-private-images.md b/docs/vendor/tutorial-ecr-private-images.md index 2b54bb6719..96c60e35b0 100644 --- a/docs/vendor/tutorial-ecr-private-images.md +++ b/docs/vendor/tutorial-ecr-private-images.md @@ -38,10 +38,6 @@ We are going to use the default NGINX deployment to create our application and t In this section, we cover at a high level the steps to create a new application and install it on a VM. -For more detailed information about how to create and install an application, follow one of the following getting started tutorials: -* [UI Tutorial](tutorial-ui-setup) -* [CLI Tutorial](tutorial-cli-setup) - To create our sample application follow these steps: * Create a new application in the Replicated [vendor portal](https://vendor.replicated.com) and call it 'MySampleECRApp'. diff --git a/docs/vendor/tutorial-ui-create-app.md b/docs/vendor/tutorial-ui-create-app.md deleted file mode 100644 index 0ed341ba43..0000000000 --- a/docs/vendor/tutorial-ui-create-app.md +++ /dev/null @@ -1,21 +0,0 @@ -# Step 1: Create an Application - -When you create an application object in the Replicated Vendor Portal, example NGINX manifest files are included that will be used for this tutorial. - -To begin, create an application object in the Vendor Portal: - -1. Log in (or create a new team) to the [Vendor Portal](https://vendor.replicated.com). - - After signing up and activating your account, the **Create application** page opens. If you are logging in with an existing account, select **Create new app** from the application drop-down list. - -1. Enter a name for the new application, such as Starter Application or NGINX Example. - - ![Create Application](/images/guides/kots/create-application.png) - -1. Click **Create Application**. - - The application is created and the Channels page opens, displaying a list of your release channels. Channels are logical stacks that you use to stage and promote releases to your customers. You will explore this in more detail later. - -## Next Step - -Continue to [Step 2: Create a Release](tutorial-ui-create-release) to create your initial release. diff --git a/docs/vendor/tutorial-ui-create-customer.md b/docs/vendor/tutorial-ui-create-customer.md deleted file mode 100644 index 439233db5d..0000000000 --- a/docs/vendor/tutorial-ui-create-customer.md +++ /dev/null @@ -1,32 +0,0 @@ -# Step 3: Create a Customer - -After promoting the first release, create a customer and download the license file so that you can install the application. - -A _customer_ is an object in the Vendor Portal that represents a single licensed user of your application. When you create a customer, you define entitlement information for the user, and the Vendor Portal generates a YAML license file for the customer that you can download. - -When you install the application later in this tutorial, you will upload the license file that you create in this step. The license allows KOTS to create the application containers. - -To create a customer license and download the license file: - -1. From the Vendor Portal, select **Customers** from the left menu. - -1. Click **Create your first customer**. - - The Create a new customer page opens. - -1. Edit the following fields, leaving the rest of the fields set to the default values: - - 1. Enter a name for the **Customer Name**. - 1. Select **Unstable** for the **Assigned Channel**. The Unstable channel is where you promoted the release in [Step 3: Create a Release](tutorial-ui-create-release). Assigning the customer to a channel allows them to install the releases that are promoted to that channel. - - ![Create Customer](/images/guides/kots/create-customer.png) - - 1. Click **Save Changes**. - - 1. Click **Download license** from the dropdown menu in the upper right corner. - - The license file with your customer name and a YAML extension is downloaded. This is the license file that your customer uses to install your application. You will also use this license file to install and test the application. - -## Next Step - -Continue to [Step 4: Install KOTS](tutorial-ui-install-app-manager) to get the installation commands from the Unstable channel and install the KOTS components. diff --git a/docs/vendor/tutorial-ui-create-new-version.md b/docs/vendor/tutorial-ui-create-new-version.md deleted file mode 100644 index 2a316cae27..0000000000 --- a/docs/vendor/tutorial-ui-create-new-version.md +++ /dev/null @@ -1,99 +0,0 @@ -# Step 6: Create a New Version - -In this step, you edit the Replicated Config custom resource file to create a new field on the KOTS Admin Console **Config** page. You then promote the new release to the Unstable channel with your changes. - -To create and promote a new version of the application: - -1. From the Vendor Portal, click **Releases** > **Create Release**. - - The YAML editor opens and shows the contents of the most recently created release. This gives you everything that you have done so far. - -1. In the `kots-config.yaml` file, copy and paste the following YAML into the file under the `example_default_value` field to create a new text field on the Admin Console **Config** page: - - ```yaml - - name: more_text - title: Another Text Example - type: text - value: "" - when: repl{{ ConfigOptionEquals "show_text_inputs" "1" }} - ``` - - The following shows the full YAML for the `kots-config.yaml` file after you add the new field: - - ```yaml - apiVersion: kots.io/v1beta1 - kind: Config - metadata: - name: config-sample - spec: - groups: - - name: example_settings - title: My Example Config - description: Configuration to serve as an example for creating your own. See [https://kots.io/reference/v1beta1/config/](https://kots.io/reference/v1beta1/config/) for configuration docs. In this case, we provide example fields for configuring an Nginx welcome page. - items: - - name: show_text_inputs - title: Customize Text Inputs - help_text: "Show custom user text inputs" - type: bool - default: "0" - recommended: true - - name: example_default_value - title: Text Example (with default value) - type: text - value: "" - default: please change this value - when: repl{{ ConfigOptionEquals "show_text_inputs" "1" }} - # Add the new more_text field here - - name: more_text - title: Another Text Example - type: text - value: "" - when: repl{{ ConfigOptionEquals "show_text_inputs" "1" }} - - name: api_token - title: API token - type: password - props: - rows: 5 - when: repl{{ ConfigOptionEquals "show_text_inputs" "1" }} - - name: readonly_text_left - title: Readonly Text - type: text - value: "{{repl RandomString 10}}" - readonly: true - when: repl{{ ConfigOptionEquals "show_text_inputs" "1" }} - - name: hidden_text - title: Secret Key - type: password - hidden: true - value: "{{repl RandomString 40}}" - - ``` -1. Check the linter messages in the Help pane to ensure there are no errors. - -1. In the `example-configmap.yaml` file, copy and paste the following HTML to replace the `` section: - - ``` - - This is an example KOTS application. -

This is text from a user config value: '{{repl ConfigOption "example_default_value"}}'

-

This is more text from a user config value: '{{repl ConfigOption "more_text"}}'

-

This is a hidden value: '{{repl ConfigOption "hidden_text"}}'

- - ``` - This creates a reference to the `more_text` field using a Replicated KOTS template function. The ConfigOption template function renders the user input from the configuration item that you specify. For more information, see [Config Context](/reference/template-functions-config-context) in _Reference_. - -1. Check the linter messages in the Help pane to ensure there are no errors. - -1. Click **Save Release**. - -1. Promote the release to a channel: - - 1. Click **Promote** at the top of the page. - - 1. Choose the Unstable channel in the Promote Release dialog, and click **Promote**. - - Any license installed from the Unstable channel will start with this new release, and any installation already running is prompted to update to the new release when the Admin Console checks for updates. - -## Next Step - -Continue to [Step 7: Update the Application](tutorial-ui-update-app) to return to the Admin Console to update the application to the new version. diff --git a/docs/vendor/tutorial-ui-create-release.md b/docs/vendor/tutorial-ui-create-release.md deleted file mode 100644 index a579f09c25..0000000000 --- a/docs/vendor/tutorial-ui-create-release.md +++ /dev/null @@ -1,125 +0,0 @@ -# Step 2: Create a Release - -Now that you have created an application object that contains example YAML manifest files, you can create a release and promote it to the Unstable channel. - -By default, the Vendor Portal includes Unstable, Beta, and Stable release channels. The Unstable channel is intended for software vendors to use for internal testing, before promoting a release to the Beta or Stable channels for distribution to customers. For more information about channels, see [About Channels and Releases](releases-about). - -To create a release: - -1. Click **Releases** from the left menu, and click **Create a release**. - - ![Create Release](/images/guides/kots/create-release.png) - - A YAML editor opens, where you can manage your application files. - - The default YAML manifest files above the white line contain information for KOTS, preflight checks, customer configuration screen options, and support bundle analyzers for troubleshooting installations. Most of these files are Replicated custom resource files. For more information about custom resources, see the [About Custom Resources](/reference/custom-resource-about). - - The files below the white line are the sample NGINX application files. - - ![Default YAML](/images/guides/kots/default-yaml.png) - -1. In the `kots-preflights.yaml` file, copy and paste the following YAML underneath the `nodeResources` field. This YAML creates a second `nodeResources` field that checks for the number of nodes in the cluster, and triggers a warning during the deployment if the number of nodes does not meet the requirement: - - ```yaml - - nodeResources: - checkName: Must have at least 3 nodes in the cluster - outcomes: - - warn: - when: "count() < 3" - message: This application requires at least 3 nodes - - pass: - message: This cluster has enough nodes. - ``` - - Your entire Preflight YAML file should look like this: - - ```yaml - apiVersion: troubleshoot.sh/v1beta2 - kind: Preflight - metadata: - name: preflight-checks - spec: - analyzers: - - clusterVersion: - outcomes: - - fail: - when: "< 1.20.0" - message: The application requires Kubernetes 1.20.0 or later, and recommends 1.21.0 or later. - uri: https://www.kubernetes.io - - warn: - when: "< 1.21.0" - message: Your cluster meets the minimum version of Kubernetes, but we recommend you update to 1.21.0 or later. - uri: https://kubernetes.io - - pass: - message: Your cluster meets the recommended and required versions of Kubernetes. - - containerRuntime: - outcomes: - - pass: - when: "== containerd" - message: containerd container runtime was found. - - fail: - message: Did not find containerd container runtime. - - distribution: - outcomes: - - fail: - when: "== docker-desktop" - message: The application does not support Docker Desktop clusters. - - fail: - when: "== microk8s" - message: The application does not support MicroK8s clusters. - - fail: - when: "== minikube" - message: The application does not support minikube clusters. - - pass: - when: "== eks" - message: EKS is a supported distribution. - - pass: - when: "== gke" - message: GKE is a supported distribution. - - pass: - when: "== aks" - message: AKS is a supported distribution. - - pass: - when: "== kurl" - message: kURL is a supported distribution. - - pass: - when: "== digitalocean" - message: DigitalOcean is a supported distribution. - - warn: - message: Unable to determine the distribution of Kubernetes. - - nodeResources: - checkName: Total CPU Cores - outcomes: - - fail: - when: "sum(cpuCapacity) < 2" - message: The cluster must contain at least 2 cores, and should contain at least 4 cores. - - warn: - when: "sum(cpuCapacity) < 4" - message: The cluster should contain at least 4 cores. - - pass: - message: There are at least 4 cores in the cluster. - - nodeResources: - checkName: Must have at least 3 nodes in the cluster - outcomes: - - warn: - when: "count() < 3" - message: This application requires at least 3 nodes - - pass: - message: This cluster has enough nodes. - ``` - - Preflight checks are designed to help ensure that the environment meets the minimum system and software requirements to run the application. Software vendors define preflight checks in the Preflight custom resource. For more information, see [Preflight and Support Bundle](/reference/custom-resource-preflight). - -1. Check the linter messages in the **Help** pane. If there are no errors, a message displays letting you know that everything looks good. If there are errors, information about the errors displays with a link to the reference documentation. For more information about the linter, see [Linter Rules](/reference/linter). - -1. Click **Save release**. - -1. Click **Promote**. - - In the **Promote Release** dialog that opens, select the Unstable channel and click **Promote**. Promoting a release makes it available for installation. - - ![Create Application](/images/guides/kots/promote-release.png) - -## Next Step - -Continue to [Step 3: Create a Customer](tutorial-ui-create-customer) to create a customer license file that you will upload when installing the application. diff --git a/docs/vendor/tutorial-ui-deploy-app.md b/docs/vendor/tutorial-ui-deploy-app.md deleted file mode 100644 index b03191a908..0000000000 --- a/docs/vendor/tutorial-ui-deploy-app.md +++ /dev/null @@ -1,87 +0,0 @@ -# Step 5: Deploy the Application - -After you run the installation script from the previous step, the KOTS Admin Console and Kubernetes are running, but the application is not deployed yet. - -This procedure shows you how to deploy the application by logging into the Admin Console, uploading the license file that you created as part of [Step 3: Create a Customer](tutorial-ui-create-customer), completing the application configuration settings, and running the preflight checks. - -To install and deploy the application: - -1. In a browser, enter the URL `http://localhost:8800`. - -1. On the Upload license page, select the customer license YAML file or drag and drop the license file from your desktop. Click **Upload license**. - - The Admin Console can pull the application YAML and containers now. - -1. On the configuration screen, select the **Customize Text Inputs** checkbox. In the **Text Example** field, enter any text. For example, `Hello`. - - This page displays configuration settings that are specific to the application. Software vendors define the fields that are displayed on this page in the Config custom resource. For more information, see [Config](/reference/custom-resource-config) in _Reference_. - - There are other example configuration options on this page. Feel free to explore and toggle some of the options. You can see the results of your changes later. - - :::note - You will customize what appears on this screen in a later step. - ::: - -1. Click **Continue**. - - The preflight checks run automatically. In the **Results from your preflight checks** list, look for the status of the number of nodes in the cluster. It should show the pass or warning messages that you configured earlier, depending on your cluster setup. - - ![Preflight Results](/images/preflight-warning.png) - -1. Ignore any preflight warnings and click **Continue**. If there are failing preflight checks, click **Deploy and continue** in the dialog. - - The Admin Console dashboard opens. - - ![Cluster](/images/guides/kots/application-tutorial-ui.png) - - On the **Dashboard** tab, users can take various actions, including viewing the application status, opening the application, checking for application updates, syncing their license, and setting up application monitoring on the cluster with Prometheus. - -1. Click **Open App** to view the application in your browser. - - ![Open App](/images/guides/kots/open-app.png) - - Notice that the text that you entered previously on the Configure App Name page is displayed on the application screen. - -1. In your cluster, press **Ctrl + C** to exit the Admin Console. - -1. Run the following command to reload your shell so that you can access the cluster with kubectl: - - ```bash - bash -l - ``` -1. Run the following command to see the example NGINX service that you just deployed: - - ```bash - kubectl get pods --namespace NAMESPACE_NAME - ``` - Replace `NAMESPACE_NAME` with the namespace where the application and Admin Console are deployed. Typically this value is `default`. - - **Example output:** - - ``` - NAME READY STATUS RESTARTS AGE - kotsadm-7595595bf5-pmlng 1/1 Running 0 21m - kotsadm-minio-0 1/1 Running 0 22m - kotsadm-rqlite-0 1/1 Running 0 22m - nginx-667f4fc76b-8gvr9 1/1 Running 0 17m - ``` - -1. Run the following command to start the console again: - - ```bash - kubectl kots admin-console --namespace NAMESPACE_NAME - ``` - - Replace `NAMESPACE_NAME` with the namespace where the application and Admin Console are deployed. Typically this value is `default`. - - If you are using a VM that is behind a firewall and you get an error message, you might need to create a firewall rule to enable access to port 8800. For more information, see [Installation Requirements](/enterprise/installing-general-requirements). - -1. Under **Customers** in the Vendor Portal, select the customer name to open the **Reporting** page. In the **Instances** pane, you can verify that the instance is active and drill down from the details area to see the **Instance details** page. For more information, see [Customer Reporting](customer-reporting) and [Instance Details](instance-insights-details). - - ![Customer instance reporting](/images/customer-instances-tutorial.png) - - [View a larger version of this image](/images/customer-instances-tutorial.png) - -## Next Step - -Continue to [Step 6: Create a New Version](tutorial-ui-create-new-version) to make a change to one of the manifest files and promote a new release. diff --git a/docs/vendor/tutorial-ui-install-app-manager.mdx b/docs/vendor/tutorial-ui-install-app-manager.mdx deleted file mode 100644 index 8068dc2361..0000000000 --- a/docs/vendor/tutorial-ui-install-app-manager.mdx +++ /dev/null @@ -1,46 +0,0 @@ -# Step 4: Install KOTS - -Get the installation commands from the Unstable channel so that you can test the installation process for the application release that you promoted. The first step in installing and deploying the application in a cluster is to install KOTS. - -KOTS lets your users install, manage, and upgrade your application. Users can interact with KOTS through the Admin Console or through the KOTS CLI. - -To install KOTS: - -1. Make sure your kubectl context is set to your cluster. - -1. Copy the **KOTS Install** command from the Unstable channel in the Vendor Portal. - - ![Installation Methods](/images/guides/kots/installation-methods-existing.png) - - The script installs the latest KOTS version as a `kubectl` plugin. For more information about installing an application with the KOTS CLI, see [install](../reference/kots-cli-install/) in the KOTS CLI documentation. - - **Example:** - - ```bash - curl https://kots.io/install | bash - kubectl kots install my-test-app/unstable - ``` - -1. For `Enter installation path (leave blank for /usr/local/bin):`, use the default and press **Enter**. - -1. For `Enter a new password to be used for the Admin Console:`, provide a password to access the Admin Console. You use this password in a later step to access the Admin Console and deploy the application. - - When the Admin Console is ready, the script prints the https://localhost:8800 URL where you can access the Admin Console. - - **Example output:** - - ```bash - Enter the namespace to deploy to: my-app-unstable - • 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 - ``` - -## Next Step - -Continue to [Step 5: Deploy the Application](tutorial-ui-deploy-app) to log in to the Admin Console and deploy the application. diff --git a/docs/vendor/tutorial-ui-setup.mdx b/docs/vendor/tutorial-ui-setup.mdx deleted file mode 100644 index 92df52ab1d..0000000000 --- a/docs/vendor/tutorial-ui-setup.mdx +++ /dev/null @@ -1,37 +0,0 @@ -import KubernetesTraining from "../partials/getting-started/_kubernetes-training.mdx" -import LabsIntro from "../partials/getting-started/_labs-intro.mdx" -import TutorialIntro from "../partials/getting-started/_tutorial-intro.mdx" -import RelatedTopics from "../partials/getting-started/_related-topics.mdx" -import VMRequirements from "../partials/getting-started/_vm-requirements.mdx" - -# Introduction and Setup - - - -The steps in this KOTS UI-based tutorial show you how to use the Replicated Vendor Portal to perform these tasks. The Vendor Portal is the user interface that you use as a software vendor to create, configure, and manage your application artifacts, including application releases, release channels, customer entitlements, private image registries, and more. - -For a tutorial that demonstrates how to use the Replicated CLI to create and promote releases for your application, see [CLI Tutorial](tutorial-cli-setup). - - - -## Set Up the Environment - -As part of this tutorial, you will install a sample application into a Kubernetes cluster. Before you begin, do the following to set up your environment: - -* Create a Kubernetes cluster that meets the minimum system requirements described in [Existing Cluster Requirements](/enterprise/installing-general-requirements#existing-cluster-requirements) in _Installation Requirements_. You can use any cloud provider or tool that you prefer to create a cluster, such as Google Kubernetes Engine (GKE), Amazon Web Services (AWS), or minikube. - - **Example:** - - For example, to create a cluster in GKE, run the following command in the gcloud CLI: - - ``` - gcloud container clusters create NAME --preemptible --no-enable-ip-alias - ``` - Where `NAME` is any name for the cluster. - -* Install kubectl, the Kubernetes command line tool. See [Install Tools](https://kubernetes.io/docs/tasks/tools/) in the Kubernetes documentation. -* Configure kubectl command line access to the cluster that you created. See [Command line tool (kubectl)](https://kubernetes.io/docs/reference/kubectl/) in the Kubernetes documentation. - -## Related Topics - - diff --git a/docs/vendor/tutorial-ui-update-app.md b/docs/vendor/tutorial-ui-update-app.md deleted file mode 100644 index 17084ac5b3..0000000000 --- a/docs/vendor/tutorial-ui-update-app.md +++ /dev/null @@ -1,57 +0,0 @@ -# Step 7: Update the Application - -To deploy and test this updated release, you return to the KOTS Admin Console using a web browser. - -At this point, the Admin Console likely shows that your test application is up-to-date and that no updates are available. The Admin Console checks for new updates approximately every four hours, but for now, you will trigger a check manually. - -To update the application: - -1. Log in to the Admin Console at `https://localhost:8800`. - -1. On the Version history tab, click **Check for update**. You should see a new release in the history now. You can click **Diff versions** to review the differences in the YAML files. - - ![View Update](/images/guides/kots/view-update.png) - -1. Click **Deploy**. In the dialog that opens, click **Yes, deploy** to deploy the new version. The deployment takes only a few seconds. - -1. On the Config tab, look for the **Another Text Example** field that you added is displayed. - -1. In the new **Another Text Example** field, enter any text. Click **Save config**. - - The Admin Console notifies you that the configuration settings for the application have changed. - -1. In the dialog, click **Go to updated version**. - - The updated version is loaded on the Version history page. - -1. On the Version history page, click **Deploy** next to the latest version to deploy the configuration change. - -1. After the Admin Console deploys the configuration change, go to the Dashboard page and click **Open App**. - - The application displays the text that you added to the field. - - :::note - If you do not see the new text, refresh your browser. - ::: - -1. In the vendor portal, return to the **Customers > Reporting** page. Confirm that you can see the new application version in the **Instances** pane and then drill down from the details area to see the **Instance details** page. - -## Next Steps - -Congratulations! As part of this tutorial, you: - -- Created and promoted a release for a Kubernetes application using the vendor portal -- Installed the application in a cluster -- Edited the manifest files for the application: - - Added a preflight check - - Added a new configuration field and used template functions to reference the field -- Promoted a new release with your changes -- Used the Admin Console to update the application to the latest version - -As a next step you can: - -- Learn how to use the CLI to perform these steps and manage your release YAML in a git repository. See the [CLI Tutorial](tutorial-cli-setup). - -- Continue to iterate on your sample application by integrating other KOTS features. See [Onboarding with KOTS](distributing-workflow). - -- Make more customizations to the fields that appear on the **Config** page in the Admin Console screen. This screen is used to collect the configuration that your application needs from the customer. Values are available to your app as text templates or input values to Helm Charts. diff --git a/netlify.toml b/netlify.toml index 80b0270ed0..666128bd7b 100644 --- a/netlify.toml +++ b/netlify.toml @@ -47,7 +47,7 @@ ################################################### [[redirects]] from = "https://docs.replicated.com/vendor/tutorial-installing-with-existing-cluster" - to = "https://docs.replicated.com/vendor/tutorial-ui-setup" + to = "https://docs.replicated.com/vendor/tutorial-cli-setup" [[redirects]] from = "https://docs.replicated.com/vendor/tutorial-installing-with-cli" @@ -55,7 +55,7 @@ [[redirects]] from = "https://docs.replicated.com/vendor/tutorial-installing-without-existing-cluster" - to = "https://docs.replicated.com/vendor/tutorial-ui-setup" + to = "https://docs.replicated.com/vendor/tutorial-embedded-cluster-setup" [[redirects]] from = "https://docs.replicated.com/vendor/helm-mapping-example" diff --git a/sidebars.js b/sidebars.js index b1cefe90ff..342e92fee8 100644 --- a/sidebars.js +++ b/sidebars.js @@ -63,21 +63,7 @@ const sidebars = { items: [ { type: 'category', - label: 'Deploy a Helm Chart with KOTS and the Helm CLI', - items: [ - 'vendor/tutorial-kots-helm-setup', - 'vendor/tutorial-kots-helm-get-chart', - 'vendor/tutorial-kots-helm-create-app', - 'vendor/tutorial-kots-helm-package-chart', - 'vendor/tutorial-kots-helm-create-release', - 'vendor/tutorial-kots-helm-create-customer', - 'vendor/tutorial-kots-helm-install-kots', - 'vendor/tutorial-kots-helm-install-helm', - ], - }, - { - type: 'category', - label: 'Deploy a Helm Chart on a VM with Embedded Cluster', + label: 'Install a Helm Chart on a VM with Embedded Cluster', items: [ 'vendor/tutorial-embedded-cluster-setup', 'vendor/tutorial-embedded-cluster-create-app', @@ -89,21 +75,21 @@ const sidebars = { }, { type: 'category', - label: 'KOTS Tutorial (UI)', + label: 'Install a Helm Chart with KOTS and the Helm CLI', items: [ - 'vendor/tutorial-ui-setup', - 'vendor/tutorial-ui-create-app', - 'vendor/tutorial-ui-create-release', - 'vendor/tutorial-ui-create-customer', - 'vendor/tutorial-ui-install-app-manager', - 'vendor/tutorial-ui-deploy-app', - 'vendor/tutorial-ui-create-new-version', - 'vendor/tutorial-ui-update-app', + 'vendor/tutorial-kots-helm-setup', + 'vendor/tutorial-kots-helm-get-chart', + 'vendor/tutorial-kots-helm-create-app', + 'vendor/tutorial-kots-helm-package-chart', + 'vendor/tutorial-kots-helm-create-release', + 'vendor/tutorial-kots-helm-create-customer', + 'vendor/tutorial-kots-helm-install-kots', + 'vendor/tutorial-kots-helm-install-helm', ], }, { type: 'category', - label: 'KOTS Tutorial (CLI)', + label: 'Install with KOTS in an Existing Cluster', items: [ 'vendor/tutorial-cli-setup', 'vendor/tutorial-cli-install-cli',