> For the complete documentation index, see [llms.txt](https://docs.cybus.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cybus.io/1-10-1/documentation/connectware-on-kubernetes/connectware-helm-chart.md). # Connectware Helm Chart [Helm](https://helm.sh) is a package manager for Kubernetes that offers a simple way to deploy complex applications into Kubernetes clusters. Helm packages are called charts and are paired with a YAML file that contains the configuration for the application. The YAML file is called values.yaml. ## Obtaining the local name of your Connectware Helm repository The local name of your Connectware Helm repository corresponds to the following URL: * To display the local name of your Connectware Helm repository, enter the following command: helm repo list For the code examples in this documentation, we use the variable `local-repo` to refer to the local name of your Connectware Helm repository. ## Obtaining the name, namespace, and version of your Connectware installation If you want to upgrade and configure Connectware, you must know the name, namespace, and version of your Connectware installation. **Prerequisites** * Helm version 3 is installed on your system. * The Kubernetes command line tool kubectl is configured and has access to the target installation. **Procedure** * To display the name, namespace, and app version of your Connectware installation, enter the following command: `helm list -A` **Result** The name, namespace, and version number of your Connectware installation is displayed in the **NAME**, **NAMESPACE**, and **APP VERSION** columns. If you have trouble locating your Connectware installation in the list, look for connectware in the **CHART** column. | NAME | NAMESPACE | REVISION | UPDATED | STATUS | CHART | APP VERSION | | ----------- | ----------- | -------- | --------------------------------------- | -------- | ----------------- | ----------- | | connectware | connectware | 4 | 2022-12-01 17:04:16.664663648 +0100 CET | deployed | connectware-1.1.0 | 1.1.0 | For the code examples in this documentation, we use the following variables: * Name: `installation-name` * Namespace: `namespace` * App version: `current-version` ## Extracting the values.yaml file The Helm configuration that Connectware uses is stored in the values.yaml file. You can extract the values.yaml file from your installation. **Prerequisites** * Helm version 3 is installed on your system. * The Kubernetes command line tool kubectl is configured and has access to the target installation. * You know the name and namespace of your Connectware installation. See [Obtaining the Name, Namespace, and Version of Your Connectware Installation](#obtaining-the-name-namespace-and-version-of-your-connectware-installation). **Procedure** * To extract this file from your installation, enter the following command: {% code lineNumbers="true" %} ```yaml helm get values -n -o yaml > values.yaml ``` {% endcode %} For the code examples in this documentation, we use the variable values.yaml to refer to the currently used Helm values. **Related Links** * [Configuring the values.yaml File](https://docs.cybus.io/1-10-1/documentation/connectware-on-kubernetes/pages/wlCTcy4OBt18D5dYvbBw#configuring-the-values.yaml-file) ## Applying Helm configuration changes When you have changed the Helm configuration in your values.yaml file, you must apply the changes via an Helm upgrade. Important: When you apply the changes that you have made to the values.yaml file, the former configuration is overwritten. We recommend that you apply configuration changes during planned maintenance times. **Prerequisites** * Helm version 3 is installed on your system. * The Kubernetes command line tool kubectl is configured and has access to the target installation. * You know the name and namespace of your Connectware installation. See [Obtaining the Name, Namespace, and Version of Your Connectware Installation](#obtaining-the-name-namespace-and-version-of-your-connectware-installation). * The values.yaml file is available. **Procedure** 1. In the values.yaml file, edit the configuration parameters. Make sure to stick to the YAML indentation rules. 2. To apply the changed configuration parameters, enter the following command: {% code lineNumbers="true" %} ```yaml helm upgrade -n -f values.yaml ``` {% endcode %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## 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, and the optional `goal` query parameter: ``` GET https://docs.cybus.io/1-10-1/documentation/connectware-on-kubernetes/connectware-helm-chart.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. 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.