Skip to content

DOC-6134 #225

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.

Sign up for GitHub

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

Merged
aimurphy merged 1 commit into from
Sep 25, 2026
Merged

DOC-6134 #225

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 5 additions & 10 deletions modules/operations/pages/auth.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,22 +37,19 @@ include::operations:partial$manually-create-credentials.adoc[]

== TLS

=== Automatically generating certificates using cert-manager

To automatically generate certificates using cert-manager, see https://cert-manager.io/docs/[Cert-Manager Documentation].

=== Manually configuring certificate secrets for TLS

To use TLS, you must first create a certificate and store it in the secret defined by `tlsSecretName`.
Alternatively, you can manually configure certificate secrets for TLS by creating a certificate and storing it in the secret defined by `tlsSecretName`.

Create the certificate:
Use `kubectl create secret tls` to create a secret of type `kubernetes.io/tls`:

[source,bash]
----
kubectl create secret tls <tlsSecretName> --key <keyFile> --cert <certFile>
----

The resulting secret will be of type `kubernetes.io/tls`. The key should *not* be in `PKCS 8` format, even though that is the format used by {pulsar-short}. The `kubernetes.io/tls` format will be converted by the chart to `PKCS 8`.
It is expected that this key will _not_ be in `PKCS 8` format, even though that is the format used by {pulsar-short}.
The `kubernetes.io/tls` format will be converted to `PKCS 8` by the chart.

If you have a self-signed certificate, manually specify the certificate information directly in {pulsar-helm-chart-repo}/blob/master/examples/dev-values-keycloak-auth.yaml[values]:

Expand All @@ -64,9 +61,7 @@ If you have a self-signed certificate, manually specify the certificate informat
# caCertificate: |
----

Once you have created the secrets that store the certificate info (or manually specified it in {pulsar-helm-chart-repo}/blob/master/examples/dev-values-keycloak-auth.yaml[values]), enable TLS in the values:

`enableTls: yes`
Once you have created the secrets that store the certificate info (or manually specified it in {pulsar-helm-chart-repo}/blob/master/examples/dev-values-keycloak-auth.yaml[values]), enable TLS in the values with `enableTls: yes`.

== Token Authentication via Keycloak Integration

Expand Down
Loading