Skip to content
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

Jump to bottom

Removed references to consolidated-channel-specific secrets #3729

Merged
merged 4 commits into from
Jun 7, 2021
Merged

Removed references to consolidated-channel-specific secrets #3729

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
77d98e8
Updated samples/kafka/channel with configmap information
eric-sap May 27, 2021
075fe1c
Merge branch 'mkdocs' of https://github.com/knative/docs into mkdocs
eric-sap Jun 4, 2021
70d9459
Merge branch 'knative:mkdocs' into mkdocs
eric-sap Jun 4, 2021
6770f31
Removed references to old-style consolidated channel secret format
eric-sap Jun 4, 2021
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
64 changes: 4 additions & 60 deletions docs/eventing/samples/kafka/channel/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,63 +167,7 @@ Kafka cluster, with the two supported TLS and SASL authentication methods.
Kafka channels require certificates to be in `.pem` format. If your files
are in a different format, you must convert them to `.pem`.

Follow the section corresponding to the channel type that you used
(consolidated or distributed) when installing eventing-kafka:

### Consolidated channel authentication

#### TLS authentication

To use TLS authentication you must have a CA root certificate as well as
a client certificate and key.

1. Create the certificate files as secret fields in your chosen namespace:
```shell
kubectl create secret --namespace <namespace> generic <kafka-auth-secret> \
--from-file=ca.crt=caroot.pem \
--from-file=user.crt=certificate.pem \
--from-file=user.key=key.pem
```

!!! note
It is important to use the same keys (`ca.crt`, `user.crt` and `user.key`).

#### SASL authentication

To use SASL authentication, you will need the following information:

- A username and password.
- The type of SASL mechanism you wish to use. For example; `PLAIN`, `SCRAM-SHA-256` or `SCRAM-SHA-512`.

!!! note
It is recommended to also enable TLS. If you enable this, you will also
need the `ca.crt` certificate as described in the previous section.

1. Create a secret with a `ca.crt` field if using a custom CA certificate,
for example:
```shell
kubectl create secret --namespace <namespace> generic <kafka-auth-secret> \
--from-file=ca.crt=caroot.pem \
--from-literal=password="SecretPassword" \
--from-literal=saslType="SCRAM-SHA-512" \
--from-literal=user="my-sasl-user"
```
2. Optional. If you want to use public CA certificates, you must use the
`tls.enabled=true` flag, rather than the `ca.crt` argument, for example:
```shell
kubectl create secret --namespace <namespace> generic <kafka-auth-secret> \
--from-literal=tls.enabled=true \
--from-literal=password="SecretPassword" \
--from-literal=saslType="SCRAM-SHA-512" \
--from-literal=user="my-sasl-user"
```

!!! note
It is important to use the same keys; `user`, `password` and `saslType`.

### Distributed channel authentication

#### TLS authentication
### TLS authentication

1. Edit your config-kafka ConfigMap:
```shell
Expand Down Expand Up @@ -261,7 +205,7 @@ To use SASL authentication, you will need the following information:
...
```

#### SASL authentication
### SASL authentication

To use SASL authentication, you will need the following information:

Expand Down Expand Up @@ -294,7 +238,7 @@ To use SASL authentication, you will need the following information:
--from-literal=username="my-sasl-user"
```

### All channel types and authentication methods
### All authentication methods

1. If you have created a secret for your desired authentication method by
using the previous steps, reference the secret and the namespace of the
Expand All @@ -312,7 +256,7 @@ To use SASL authentication, you will need the following information:
!!! note
The default secret name and namespace are `kafka-cluster` and
`knative-eventing` respectively. If you reference a secret in a different
namespace, be sure your roles and bindings are configured so that the
namespace, be sure you configure your roles and bindings so that the
knative-eventing pods can access it.

## Channel configuration
Expand Down