Installation

Installing the Kluctl Webui

The Kluctl Webui can be installed by using a Git Include that refers to the webui deployment project. Example:

deployments:
  - git:
      url: https://github.com/kluctl/kluctl.git
      subDir: install/webui
      ref:
        tag: v2.25.1

Login

Static Users

By default, the Webui will automatically generate an static credentials for an admin and for a viewer user. These credentials can be extracted from the kluctl-system/webui-secret Secret after the Webui has started up for the first time. To get the admin password, invoke:

$ kubectl -n kluctl-system get secret webui-secret -o jsonpath='{.data.admin-password}' | base64 -d

For the viewer password, invoke:

$ kubectl -n kluctl-system get secret webui-secret -o jsonpath='{.data.viewer-password}' | base64 -d

If you do not want to rely on the Webui to generate those secrets, simply use your typical means of creating/updating the webui-secret Secret. The secret must contain values for admin-password, viewer-password.

OIDC Integration

The Webui offers an OIDC integration, which can be configured via CLI arguments.

For an example of an OIDC provider configurations, see Azure AD Integration.

Customization

Serving under a different path

By default, the webui is served under the /path. To change the path, pass the --prefix-path argument to the webui:

deployments:
  - git:
      url: https://github.com/kluctl/kluctl.git
      subDir: install/webui
      ref:
        tag: v2.25.1
    vars:
      - values:
          webui_args:
            - --path-prefix=/my-custom-prefix

Overriding the version

The image version of the Webui can be overriden with the kluctl_version arg:

deployments:
  - git:
      url: https://github.com/kluctl/kluctl.git
      subDir: install/webui
      ref:
        tag: main
    vars:
      - values:
          args:
            kluctl_version: v2.25.1

Passing arguments

You can pass arbitrary command line arguments to the webui by providing the webui_args arg:

deployments:
  - git:
      url: https://github.com/kluctl/kluctl.git
      subDir: install/webui
      ref:
        tag: v2.25.1
    vars:
      - values:
          webui_args:
            - --gops-agent
Last modified July 21, 2024: Sync kluctl docs for v2.25.1 (da07c77)