Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: move things around #3437

Closed
wants to merge 5 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs/docs/installation/alternative-installs/glasskube.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
comments: true
---

# Install Keptn via Glasskube

[Glasskube](https://glasskube.dev/)
is a package manager for Keptn that simplifies the installation process
and can be used to automatically upgrade Keptn to the latest version.
For more information on how to install Glasskube, see
[Glasskube Installation](https://glasskube.dev/docs/getting-started/install/).

To install Keptn via Glasskube after Glasskube is installed, run the following command:

``` shell
glasskube install keptn
```

After that, Keptn is installed on your cluster and
will be automatically upgraded to the latest version.
5 changes: 5 additions & 0 deletions docs/docs/installation/alternative-installs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
comments: true
---

# Alternative installation methods
94 changes: 91 additions & 3 deletions docs/docs/installation/configuration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,94 @@ comments: true

# Configuration

This section contains guides for specific configuration use cases for Keptn.
These will help you adjust settings that need to be set at installation time
and allocate resources required to run Keptn.
The Keptn configuration is controlled by a set of Helm value files,
summarized in the following table.
The Keptn Helm chart is an umbrella chart
that contains subcharts for all components of Keptn.
Each component has its own Helm values file
(documented in its own README file),
that defines configurations specific to that component.

All configuration changes for all components
can be made in one `values.yaml` file.
This is discussed more in
[Customizing the configuration of components](#customizing-the-configuration-of-components)
below.

The following table summarizes the Keptn `values.yaml` files.

* The "Component" column leads you to the
README files for each component where
all Helm values are documented
* The "Configuration file" column leads you to
the Helm values files for each component

| Component | Used for | Configuration file |
|-----------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|
| [Keptn](https://github.com/keptn/lifecycle-toolkit-charts/blob/main/charts/keptn/README.md) | Installs subcharts, global configuration | [keptn/values.yaml](https://github.com/keptn/lifecycle-toolkit-charts/blob/main/charts/keptn/values.yaml) |
| [lifecycle-operator](https://github.com/keptn/lifecycle-toolkit-charts/blob/main/charts/keptn-lifecycle-operator/README.md) | [Observability](../../guides/otel.md), [Release Lifecycle Management](../../core-concepts/index.md#release-lifecycle-management) | [keptn-lifecycle-operator/values.yaml](https://github.com/keptn/lifecycle-toolkit-charts/blob/main/charts/keptn-lifecycle-operator/values.yaml) |
| [metrics-operator](https://github.com/keptn/lifecycle-toolkit-charts/blob/main/charts/keptn-metrics-operator/README.md) | [Keptn metrics](../../guides/evaluatemetrics.md), [Analysis](../../guides/slo.md) | [keptn-metrics-operator/values.yaml](https://github.com/keptn/lifecycle-toolkit-charts/blob/main/charts/keptn-metrics-operator/values.yaml) |
| [cert-manager](https://github.com/keptn/lifecycle-toolkit-charts/blob/main/charts/keptn-cert-manager/README.md) | [TLS Certificate management for all Keptn components](../../components/certificate-operator.md) | [keptn-cert-manager/values.yaml](https://github.com/keptn/lifecycle-toolkit-charts/blob/main/charts/keptn-cert-manager/values.yaml) |

## Customizing the configuration of components

To modify configuration of the subcomponents of Keptn,
use the corresponding Helm values in your `values.yaml` file.
Use the subcomponent's parent value as the root for your configuration.

Here is an example `values.yaml` altering global and metrics operator values:

```yaml
{% include "./assets/values-advance-changes.yaml" %}
```

Note the additional values that are specified
in the `metricsOperator` section.
These are documented in the README file for that operator,
which is linked from the `metrics-operator` item under "Component"
in the table above.
To implement this:

* Go into the `values.yaml` file linked under "Configuration file"
* Copy the lines for the values you want to modify
* Paste those lines into your `values.yaml` file
and modify their values in that file.

### Modify Helm values

To modify Helm values:

1. Download a copy of the Helm values file:

```shell
helm show values keptn/keptn > values.yaml
```

1. Edit your local copy to modify some values

1. Add the following string
to your `helm upgrade` command to install Keptn
with your configuration changes:

```shell
--values=values.yaml
```

For example, if you create a `my.values.yaml`
and modify some configuration values,
use the following command to apply your configuration:

```shell
helm upgrade --install keptn keptn/keptn \
--values my.values.yaml \
-n keptn-system --create-namespace --wait
```

You can also use the `--set` flag
to specify a value change for the `helm upgrade --install` command.
Helm values are specified using the format:

```shell
--set key1=value1 \
--set key2=value2 ...
```
38 changes: 38 additions & 0 deletions docs/docs/installation/configuration/specific-components.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
comments: true
---

# Control what components are installed

By default, all components are included when you install Keptn.
To specify the components that are included,
you need to modify the Keptn `values.yaml` file
to disable the components you do not want to install.

Note that the Keptn Helm chart is quite flexible.
You can install all Keptn components on your cluster,
then modify the configuration to exclude some components
and update your installation.
Conversely, you can exclude some components when you install Keptn
then later add them in.

## Disable Keptn Certificate Manager (Certificates)

If you wish to use your custom certificate manager,
you can disable Keptn `cert-manager` by setting the
`certificateManager.enabled` Helm value to `false`:

```yaml
{% include "../assets/values-remove-certmanager.yaml" %}
```

For more information on using `cert-manager` with Keptn, see
[Use Keptn with cert-manager.io](../../components/certificate-operator.md).

For the full list of Helm values, see the
[keptn-cert-manager Helm chart README](https://github.com/keptn/lifecycle-toolkit-charts/blob/main/charts/keptn-cert-manager/README.md).

## Uninstalling Keptn

To uninstall Keptn from your cluster, please follow the steps
on the [Uninstall page](../uninstall.md).
150 changes: 1 addition & 149 deletions docs/docs/installation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ See
for more information.

If you want to deploy Keptn via [ArgoCD](https://argoproj.github.io/cd/),
refer to the [Deploying Keptn via ArgoCD](./configuration/argocd.md) section
refer to the [Deploying Keptn via ArgoCD](./alternative-installs/argocd.md) section
for more information.

## Basic installation
Expand Down Expand Up @@ -120,151 +120,3 @@ Some helpful hints:
```

The output shows all Keptn components that are running on your cluster.

### Alternative installation methods

#### Install Keptn via Glasskube

[Glasskube](https://glasskube.dev/)
is a package manager for Keptn that simplifies the installation process
and can be used to automatically upgrade Keptn to the latest version.
For more information on how to install Glasskube, see
[Glasskube Installation](https://glasskube.dev/docs/getting-started/install/).

To install Keptn via Glasskube after Glasskube is installed, run the following command:

``` shell
glasskube install keptn
```

After that, Keptn is installed on your cluster and
will be automatically upgraded to the latest version.

## Keptn Helm configuration

The Keptn configuration is controlled by a set of Helm value files,
summarized in the following table.
The Keptn Helm chart is an umbrella chart
that contains subcharts for all components of Keptn.
Each component has its own Helm values file
(documented in its own README file),
that defines configurations specific to that component.

All configuration changes for all components
can be made in one `values.yaml` file.
This is discussed more in
[Customizing the configuration of components](#customizing-the-configuration-of-components)
below.

The following table summarizes the Keptn `values.yaml` files.

* The "Component" column leads you to the
README files for each component where
all Helm values are documented
* The "Configuration file" column leads you to
the Helm values files for each component

| Component | Used for | Configuration file |
|----------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------| --------------------|
| [Keptn](https://github.com/keptn/lifecycle-toolkit-charts/blob/main/charts/keptn/README.md) | Installs subcharts, global configuration | [keptn/values.yaml](https://github.com/keptn/lifecycle-toolkit-charts/blob/main/charts/keptn/values.yaml) |
| [lifecycle-operator](https://github.com/keptn/lifecycle-toolkit-charts/blob/main/charts/keptn-lifecycle-operator/README.md) | [Observability](../guides/otel.md), [Release Lifecycle Management](../core-concepts/index.md#release-lifecycle-management) | [keptn-lifecycle-operator/values.yaml](https://github.com/keptn/lifecycle-toolkit-charts/blob/main/charts/keptn-lifecycle-operator/values.yaml) |
| [metrics-operator](https://github.com/keptn/lifecycle-toolkit-charts/blob/main/charts/keptn-metrics-operator/README.md) | [Keptn metrics](../guides/evaluatemetrics.md), [Analysis](../guides/slo.md) | [keptn-metrics-operator/values.yaml](https://github.com/keptn/lifecycle-toolkit-charts/blob/main/charts/keptn-metrics-operator/values.yaml) |
| [cert-manager](https://github.com/keptn/lifecycle-toolkit-charts/blob/main/charts/keptn-cert-manager/README.md) | [TLS Certificate management for all Keptn components](../components/certificate-operator.md) | [keptn-cert-manager/values.yaml](https://github.com/keptn/lifecycle-toolkit-charts/blob/main/charts/keptn-cert-manager/values.yaml) |

## Customizing the configuration of components

To modify configuration of the subcomponents of Keptn,
use the corresponding Helm values in your `values.yaml` file.
Use the subcomponent's parent value as the root for your configuration.

Here is an example `values.yaml` altering global and metrics operator values:

```yaml
{% include "./assets/values-advance-changes.yaml" %}
```

Note the additional values that are specified
in the `metricsOperator` section.
These are documented in the README file for that operator,
which is linked from the `metrics-operator` item under "Component"
in the table above.
To implement this:

* Go into the `values.yaml` file linked under "Configuration file"
* Copy the lines for the values you want to modify
* Paste those lines into your `values.yaml` file
and modify their values in that file.

### Modify Helm values

To modify Helm values:

1. Download a copy of the Helm values file:

```shell
helm show values keptn/keptn > values.yaml
```

1. Edit your local copy to modify some values

1. Add the following string
to your `helm upgrade` command to install Keptn
with your configuration changes:

```shell
--values=values.yaml
```

For example, if you create a `my.values.yaml`
and modify some configuration values,
use the following command to apply your configuration:

```shell
helm upgrade --install keptn keptn/keptn \
--values my.values.yaml \
-n keptn-system --create-namespace --wait
```

You can also use the `--set` flag
to specify a value change for the `helm upgrade --install` command.
Helm values are specified using the format:

```shell
--set key1=value1 \
--set key2=value2 ...
```

## Control what components are installed

By default, all components are included when you install Keptn.
To specify the components that are included,
you need to modify the Keptn `values.yaml` file
to disable the components you do not want to install.

Note that the Keptn Helm chart is quite flexible.
You can install all Keptn components on your cluster,
then modify the configuration to exclude some components
and update your installation.
Conversely, you can exclude some components when you install Keptn
then later add them in.

### Disable Keptn Certificate Manager (Certificates)

If you wish to use your custom certificate manager,
you can disable Keptn `cert-manager` by setting the
`certificateManager.enabled` Helm value to `false`:

```yaml
{% include "./assets/values-remove-certmanager.yaml" %}
```

For more information on using `cert-manager` with Keptn, see
[Use Keptn with cert-manager.io](../components/certificate-operator.md).

For the full list of Helm values, see the
[keptn-cert-manager Helm chart README](https://github.com/keptn/lifecycle-toolkit-charts/blob/main/charts/keptn-cert-manager/README.md).

## Uninstalling Keptn

To uninstall Keptn from your cluster, please follow the steps
on the [Uninstall page](./uninstall.md).
2 changes: 1 addition & 1 deletion docs/docs/installation/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ of the application during installation, which is disabled by default in ArgoCD.
To fix this problem, you need to install Keptn via ArgoCD again, with the use
of `finalizers` in your Argo Application.
For more information see the
[Deploy Keptn via ArgoCD](./configuration/argocd.md) section for more information.
[Deploy Keptn via ArgoCD](./alternative-installs/argocd.md) section for more information.

## I cannot see DORA metrics or OpenTelemetry traces

Expand Down
5 changes: 4 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -118,13 +118,16 @@ nav:
- docs/installation/index.md
- Uninstall: docs/installation/uninstall.md
- Upgrade: docs/installation/upgrade.md
- Alternative Installation Methods:
- docs/installation/alternative-installs/index.md
- Deploy Keptn via ArgoCD: docs/installation/alternative-installs/argocd.md
- Glasskube: docs/installation/alternative-installs/glasskube.md
- Configuration:
- docs/installation/configuration/index.md
- Restricting monitored namespaces: docs/installation/configuration/namespace-keptn.md
- Allocating namespaces for Keptn resources: docs/installation/configuration/namespace-resources.md
- vCluster installation: docs/installation/configuration/vcluster.md
- Keptn + cert-manager.io: docs/installation/configuration/cert-manager.md
- Deploy Keptn via ArgoCD: docs/installation/configuration/argocd.md
- Installation Tips and Tricks: docs/installation/tips-tricks.md
- Troubleshooting Guide: docs/installation/troubleshooting.md
- Kubernetes cluster: docs/installation/k8s.md
Expand Down