Configure Kaptain to Authenticate with a Kommander Management Cluster

Configure Kaptain to authenticate with a Kommander Management Cluster

Configure Kaptain in a managed cluster to connect to the management cluster using the Dex OIDC Provider for authentication.

Prerequisites

A Kommander management cluster.
A managed cluster, into which Kaptain will be installed.
The managed cluster is attached to the management cluster. (You will need to create a cluster via Kommander to have a managed Konvoy cluster.)
Ensure Dex is enabled and running in the Management cluster (for Enterprise customers) or the Essential cluster (for Essential customers). Dex is automatically installed with the default configuration of DKP. If you used a customized installation of DKP, ensure dex, dex-k8s-authenticator and all SSO applications have been enabled. For more information on customizations, refer to Kommander Configuration.

Ensure that DKP Kommander is installed using the default certificate and not a customer-issued or ACME certificate. Otherwise, the installation of Kaptain can break. Custom and ACME certificates are supported in Kaptain versions 2.2 and later, and DKP versions 2.3 and later.

Kaptain configuration requirements

To use the DKP Dex instance for authentication with Kaptain, collect the following information:

External OIDC provider endpoint from the management cluster
External OIDC provider CA bundle (if necessary)

Create a Dex Client

To create the external Dex Client ID, run the following commands on the (Kommander) management cluster:

Create the Dex Client, noting the client ID (in this example, kaptain-authservice) for later use:

cat <<EOF | kubectl apply -f -
apiVersion: dex.mesosphere.io/v1alpha1
kind: Client
metadata:
  name: kaptain-authservice
  namespace: kommander
spec:
  displayName: Kaptain Auth Service
  clientSecretRef:
    name: kaptain-authservice-client-secret
EOF

CODE

Create a Dex Client Secret

Generate a client secret, noting it for later use:

Example:

KAPTAIN_SECRET=$(openssl rand -hex 32)

CODE

To create a Dex client secret, run the following command on the (Kommander) management cluster:

cat <<EOF | kubectl apply -f -
apiVersion: v1
kind: Secret
metadata:
  name: kaptain-authservice-client-secret
  namespace: kommander
type: Opaque
stringData:
  client-secret: ${KAPTAIN_SECRET}
EOF

CODE

Get external OIDC provider endpoint and CA bundle

Get the management cluster's OIDC provider endpoint as https://<management-cluster-url>/dex

(Optional) In case a custom CA is provided for Kommander certificate, to get the OIDC provider CA bundle, run the following command on the (Kommander) management cluster:

kubectl get secret kommander-traefik-tls -n kommander -o jsonpath='{.data.ca\.crt}'

CODE

Install Kaptain

Create or update the ConfigMap with Kaptain’s configuration and include the following properties:

ingress:
  externalDexClientId: dex-controller-kaptain-authservice
  externalDexClientSecret: <Dex Client secret, stored as KAPTAIN_SECRET>
  oidcProviderEndpoint: <OIDC provider endpoint>
  oidcProviderBase64CaBundle: <OIDC provider CA bundle, optional>

CODE

The resulting configuration file should look similar to the following:

ingress:
  externalDexClientId: dex-controller-kaptain-authservice
  externalDexClientSecret: e4289349e99d5814e63c602373bc9520ac225a810c695d5d80a6cefe42fa939f
  oidcProviderEndpoint: https://<Management-cluster-URL>/dex
  oidcProviderBase64CaBundle: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS9tLS0tCk1JSUMrVENDQWVHZ0F3SUJBZ0lSQUp1NlBOSFVsWVZHR0AzRW9vSGNPd1F3RFFZSktvWklodmNOQVFFTEJRQXcKRlRFVE1CRUdBMVVFQXhNS2EzVmlaWEp1WlhSbGN6QWVGdzB5TURFeU1EZ3dPVFEzTkBsYUZ3MHpNREV5TURZdwpPVFEzTkRsYU1CY3hGVEFUQmdOVkJBTVRER05sY25RdGJXRnVZV2RsY2pDQ0FTSXdEUVlKS29aSWh2Y05BUUVCCkJRQURnZ0VQQURDQ0FRb0NnZ0VCQUwzQmlJR0RnVkpzRVhJUjEvc6hkdysvzzFLaG9PdkVwcVM5Mk1pS050cDkKaW1xVUtqZGFMSHVxYlBheWhuMjNwTmhUa2haL0NEOVgyb05xVFhOR0Q2SE44WGFrMWt4VE9xWnd4am9yNktydQpUWGZrREVmZGtHVG9nZUlSaEtpSUdxRUU1Vy9teWNkVkdDUThnNXEvcUprd3JIZHgyOTZMREVwSDEzMm9aQmk1CmVNMlZvNmpVYnUydkp4MHpyVnIzeVWuaUp0TlNpbnFoN1RVc2I2bTZoeFErRkVBZFY1djdraVBLVW4wdmZTVlYKQ1YwNXdmbUU0WEEyY2d5N3RpeEV3NkFCNmFOeGYwcGVSVXpXS0ZoL3FJdGpFWEg5RVJiWVJ5cDA1UGUyb2xCVwpHWXpiVDJsblVPeW5uL0I3YWZRSExWS0RPcTRsa3NmWlBoWTJQWmZwVW5NQ0F3RUFBYU5DTUVBd0RnWURWUjBQCkFRSC9CQVFEQWdLa01BOEdBMVVkRXdFQi93UUZNQU1CQWY4d0hRWURWUjBPQkJZRUZHZmtITWxVTU1hSzRtRjgKNUNPeXhPMHAvWGNNTUEwR0NTcUdTSWIzRFFFQkN3VUFBNElCQVFERjh2d3lhWnpZUmRYRGo5ODJrN0RZRDY2cwpMVE44d3Q0ZkxKbEJKODREFzd0TGJmSVdmYkJ4VzFDd0UxdEhuaTFPd3pROGkzUytpUFhuQ0dCZFNSdm5FQkJsCnF1bkpqdWRBMm9odEs5SmViTUhPTEFpbXRnWVhZdVllTFZudGxpWCtQdmxRMWxoYzByeXFENkRkWUUwckJSdlcKRkgvSTY2b2ZONGZFVlJ2RjFiSG5uZ1BsZlFUcHNRRzZFZVNoa0RvclAwSDhxNnU5RXcyaG5Ba0hwRXVlWUJibQpkeXZvRStVWTM1ck9XK3pEQ3NXNUNPRTVGWjVWQ64lRmJMRmRSUU9tdW9BaXlCV2UyTHZHdjgzdXVSZTRsSWhxCnAxSEIrZlBPTGdJVGRaSHEwYkgvdEZZNEw0YmNkRGhGYnlJRldzN01NZ2FxeCtMZThoMDNIZE5ybG5USQotLS0tWARORCBDRVJUSUZJQ0FURS0tRS0tCg==

CODE

See Install Kaptain for more information. To install Kaptain through the Kommander UI, copy and paste the configuration values from the previous section into the Kommander UI and deploy the Kaptain application.

Add the redirect URL to Kaptain authentication service in the management cluster

Once Kaptain is up, get the authservice URL from Kaptain’s authentication service by running the following command on the managed cluster:

kubectl exec -it -n kaptain-ingress authservice-0 -- sh -c 'echo $AUTHSERVICE_URL_PREFIX'

CODE

On the management cluster, add the Redirect URL to the redirectURIs list of the Dex Client’s resource:

kubectl patch client kaptain-authservice -n kommander --type merge  -p '{"spec": {"redirectURIs": ["<Authservice URL>oidc/callback"]}}'

CODE

Log in to Kaptain using the management cluster’s Dex instance

Refer to the Kaptain login section to access Kaptains's Kubeflow dashboard.