Skip to content

[Docs] Update create cluster steps to mention multiple helm repos #3996

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

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -134,11 +134,15 @@ spec:

### Select the Profiles You Want Installed at Cluster Creation

WGE inspects the namespace in the management cluster where it is deployed, and looks for a `HelmRepository` object named `weaveworks-charts`. This Kubernetes object should point to a Helm chart repository that includes the Profiles available for installation.
WGE inspects the namespace in the management cluster where it is deployed, and looks for `HelmRepository` objects. These Kubernetes objects should point to Helm chart repositories that include the Profiles available for installation.

When creating a cluster from the UI using a CAPI template, these Profiles are available for selection in the `Profiles` section of the template. For example:
When creating a cluster from the UI using a CAPI template, these Helm Repositories together with their Profiles are available for selection in the `Profiles` section of the template. For example:

![Profiles Selection](./img/profile-selection.png)
![HelmRepositories Selection](./img/hr-selection.png)

The helm repositories selection will filter down the profiles available for selection at the next step.

![Profiles Selection](./img/profiles-selection.png)

As shown above, some Profiles are optional, while others are required. This is determined when the template is authored and allows for operations teams to control which Helm packages should be installed on new clusters by default.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,14 @@ spec:
targetNamespace: nginx
- name: cert-manager
targetNamespace: cert-manager
sourceRef:
kind: HelmRepository
name: podinfo
namespace: default
```

For each profile, a sourceRef can be specified. This is the name/namespace reference to the HelmRepository where the profile can be found. The HelmRepository must be present on the rendering cluster. If this is not provided, `weaveworks-charts` is used by default.

A template with the above profiles would offer Application Developers the option
to add `nginx` and `cert-manager` resources to their templated resources, ready
for deployment to their cluster.
Expand Down