# Kubernetes install ## Before you start {% hint style="info" %} Extra notes for installing on: * **Kubernetes clusters with limited permissions**: Read the [required permissions](/5.1/setup/install-stackstate/kubernetes_openshift/required_permissions.md). * **OpenShift**: Refer to the [OpenShift installation instructions](/5.1/setup/install-stackstate/kubernetes_openshift/openshift_install.md). {% endhint %} Before you start the installation of StackState: * Check the [requirements](/5.1/setup/install-stackstate/requirements.md) to make sure that your Kubernetes environment fits the setup that you will use (recommended, minimal or non- high availability). * Check that you have the [required permissions](/5.1/setup/install-stackstate/kubernetes_openshift/required_permissions.md). * Request access credentials to pull the StackState Docker images from [StackState support](https://support.stackstate.com/). * Add the StackState helm repository to the local helm client: ``` helm repo add stackstate https://helm.stackstate.io helm repo update ``` ## Install StackState 1. [Create the namespace where StackState will be installed](#create-namespace) 2. [Generate the `values.yaml` file](#generate-values.yaml) 3. [Deploy StackState with Helm](#deploy-stackstate-with-helm) 4. [Access the StackState UI](#access-the-stackstate-ui) ### Create namespace Start by creating the namespace where you want to install StackState and deploy the secret in that namespace. In our walkthrough we will use the namespace `stackstate`: ``` kubectl create namespace stackstate ``` ### Generate `values.yaml` The `values.yaml` file is required to deploy StackState with Helm. It contains your StackState license key, StackState Receiver API key and other important information. {% hint style="info" %} **Before you continue:** Make sure you have the latest version of the Helm chart with `helm repo update`. {% endhint %} The `generate_values.sh` script in the [installation directory](https://github.com/StackVista/helm-charts/tree/master/stable/stackstate/installation) of the Helm chart will guide you through generating a `values.yaml` file that can be used to deploy StackState. You can run the `generate_values.sh` script in two ways: * **Interactive mode:** When the script is run without any arguments, it will guide you through the required configuration items. ``` ./generate_values.sh ``` * **Non-interactive mode:** Run the script with the flag `-n` to pass configuration on the command line, this is useful for scripting. ``` ./generate_values.sh -n ``` The script requires the following configuration items: | Configuration | Description | | ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Base URL ( `-b` ) | The ``. The external URL for StackState that users and agents will use to connect. For example `https://stackstate.internal`. If you haven't decided on an Ingress configuration yet, use `http://localhost:8080`. This can be updated later in the generated file. | | Username and password ( `-u` `-p` ) | The username and password used by StackState to pull images from quay.io/stackstate repositories. | | License key ( `-l` ) | The StackState license key. | | Admin API password ( `-a` ) | The password for the admin API. Note that this API contains system maintenance functionality and should only be accessible by the maintainers of the StackState installation. You can omit this from the command line, the script will prompt for it. | | Default password ( `-d` ) | The password for the default user (`admin`) to access StackState's UI. You can omit this from the command line, the script will prompt for it. | | Kubernetes cluster name ( `-k` ) | StackState will use this name to identify the cluster. In non-interactive mode, specifying `-k` will both enable [automatic Kubernetes support](#automatic-kubernetes-support) and set the cluster name. In interactive mode, you will first be asked if you want to automatically install the [Kubernetes StackPack](/5.1/stackpacks/integrations/kubernetes.md). | {% hint style="info" %} Store the generated `values.yaml` file somewhere safe. You can reuse this file for upgrades, which will save time and (more importantly) will ensure that StackState continues to use the same API key. This is desirable as it means Agents and other data providers for StackState won't need to be updated. {% endhint %} ### Deploy StackState with Helm The recommended deployment of StackState is a production ready, high availability setup with many services running redundantly. If required, it's also possible to run StackState in a non-redundant setup, where each service has only a single replica. {% hint style="info" %} The non-high availability setup is only suitable for situations that don't require high availability. {% endhint %} {% tabs %} {% tab title="High availability setup" %} To deploy StackState in a high availability setup on Kubernetes: 1. Before you deploy: * [Create the namespace where StackState will be installed](#create-namespace) * [Generate `values.yaml`](#generate-values.yaml) 2. Deploy the latest StackState version to the `stackstate` namespace with the following command: ``` helm upgrade \ --install \ --namespace stackstate \ --values values.yaml \ stackstate \ stackstate/stackstate ``` {% endtab %} {% tab title="Non-high availability setup" %} To deploy StackState in a non-high availability setup on Kubernetes: 1. Before you deploy: * [Create the namespace where StackState will be installed](#create-namespace) * [Generate `values.yaml`](#generate-values.yaml) * [Create `nonha_values.yaml`](/5.1/setup/install-stackstate/kubernetes_openshift/non_high_availability_setup.md) 2. Deploy the latest StackState version to the `stackstate` namespace with the following command: ```bash helm upgrade \ --install \ --namespace stackstate \ --values values.yaml \ --values nonha_values.yaml \ stackstate \ stackstate/stackstate ``` {% endtab %} {% endtabs %} After the install, the StackState release should be listed in the StackState namespace and all pods should be running: ``` # Check the release is listed helm list --namespace stackstate # Check pods are running # It may take some time for all pods to be installed or available kubectl get pods --namespace stackstate ``` ### Access the StackState UI After StackState has been deployed you can check if all pods are up and running: ``` kubectl get pods --namespace stackstate ``` When all pods are up, you can enable a port-forward: ``` kubectl port-forward service/stackstate-router 8080:8080 --namespace stackstate ``` StackState will now be available in your browser at `https://localhost:8080`. Log in with the username `admin` and the default password provided in the `values.yaml` file. Next steps are * Configure [ingress](/5.1/setup/install-stackstate/kubernetes_openshift/ingress.md) * Install a [StackPack](/5.1/stackpacks/about-stackpacks.md) or two * Give your [co-workers access](/5.1/configure/security/authentication.md). ## Automatic Kubernetes support StackState has built-in support for Kubernetes by means of the [Kubernetes StackPack](/5.1/stackpacks/integrations/kubernetes.md). To get started quickly, the StackState installation can automate installation of this StackPack and the required Agent for the cluster that StackState itself will be installed on. This isn't required and can always be done later from the StackPacks page of the StackState UI for StackState's cluster or any other Kuberenetes cluster. The only required information is a name for the Kubernetes cluster that will distinguish it from the other Kubernetes clusters monitored by StackState. A good choice usually is the same name that is used in the kube context configuration. This will then automatically install the StackPack and install a Daemonset for the Agent and a deployment for the so-called cluster Agent. For the full details, read the [Kubernetes StackPack](/5.1/stackpacks/integrations/kubernetes.md) page. --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://archivedocs.stackstate.com/5.1/setup/install-stackstate/kubernetes_openshift/kubernetes_install.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.