Skip to content

Commit

Permalink
Add docs for configuring custom CA on openshift (#838)
Browse files Browse the repository at this point in the history
  • Loading branch information
nrfox authored Dec 3, 2024
1 parent e6799c8 commit a9be910
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions content/en/docs/Configuration/authentication/openshift.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,39 @@ Kiali as a client for the most common use-cases. The `openshift` strategy does h
configuration settings that most people will never need but are available in case you have
a situation where the customization is needed. See the Kiali CR Reference page for the
documentation on those settings.

### Multi-Cluster - Using an internal or self-signed certificate

If you have a multi-cluster Kiali deployment and the OAuth server is configured with an external IdP that uses an internal or self-signed certificate, you can configure Kiali to trust the server's certificate by creating a ConfigMap named `kiali-oauth-cabundle` containing the CA certificate bundle for the server under the `oauth-server-ca.crt` key:

{{% alert color="info" %}}
Note that if you are deploying Kiali with `spec.deployment.instance_name` set to a value that is different than the default of `kiali`, your ConfigMap name needs to be that instance name appended with "-oauth-bundle". For example, if your instance name is "myserver" then the name of the ConfigMap must be `myserver-oauth-cabundle`.
{{% /alert %}}

```yaml
apiVersion: v1
kind: ConfigMap
metadata:
name: kiali-oauth-cabundle
namespace: istio-system # This is Kiali's install namespace
data:
oauth-server-ca.crt: <PEM encoded CA root certificate>
```

After restarting the Kiali pod, Kiali will trust this root certificate for all HTTPS requests related to OAuth authentication. If you have multiple different CAs, for different clusters, include each as a separate block in the bundle.

#### Insecure setting

{{% alert color="warning" %}}
You should only use this setting for testing and not in a production environment.
{{% /alert %}}

You can disable certificate validation between Kiali and the remote OAuth server(s) by setting `insecure_skip_verify_tls` to `true` in
the Kiali CR:

```yaml
spec:
auth:
openshift:
insecure_skip_verify_tls: true
```

0 comments on commit a9be910

Please sign in to comment.