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

[bitami/schema-registry] Integrated Schema Registry documentation with instructions for SSL setup #54308

Merged
merged 11 commits into from
Jan 24, 2024
Merged

[bitami/schema-registry] Integrated Schema Registry documentation with instructions for SSL setup #54308

Changes from 4 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
2938cf7
[bitami/schema-registry] Integrated Schema Registry documentation wit…
Dec 29, 2023
638cbe3
[bitnami/schema-registry] Fixing markdown linting warnings
Dec 29, 2023
05e8eea
[bitnami/schema-registry] Correcting blanks-around-fences linter warning
Dec 29, 2023
be60074
[bitnami/schema-registry] Correcting MD031 error for fancing
Dec 29, 2023
059f8e7
Update bitnami/schema-registry/README.md
ETisREAL Jan 19, 2024
8981b4e
Update bitnami/schema-registry/README.md
ETisREAL Jan 19, 2024
d8cdc4a
Update bitnami/schema-registry/README.md
ETisREAL Jan 19, 2024
5de970d
Merge branch 'bitnami:main' into main
ETisREAL Jan 19, 2024
ec2212e
Update README.md
ETisREAL Jan 19, 2024
68b383c
Merge branch 'main' into main
ETisREAL Jan 20, 2024
b2db855
Removed multiple blank lines before the ##Cotrnibuting section
ETisREAL Jan 20, 2024
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
28 changes: 28 additions & 0 deletions bitnami/schema-registry/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,34 @@ Please check the configuration settings for the Kakfa service in the [Kafka's RE

Please check the configuration settings for the Kakfa service in the [Zookeeper's README file](https://github.com/bitnami/containers/tree/main/bitnami/zookeeper#configuration).

## Security
ETisREAL marked this conversation as resolved.
Show resolved Hide resolved

The Schema Registry container can be setup to serve clients securely via TLS. To do so, specify the listener protocol as **https** in the `SCHEMA_REGISTRY_LISTENERS` environment variable (ex. SCHEMA_REGISTRY_LISTENERS=`http://0.0.0.0:8081`,`https://0.0.0.0:8082`).
The keystore and trustore **must** be mounted in the `/opt/bitnami/schema-registry/certs` directory as `ssl.keystore.jks` and `ssl.truststore.jks` respectively. Only jks formats are currently supported and please note that the environment variables `SCHEMA_REGISTRY_SSL_KEYSTORE_LOCATION` or `SCHEMA_REGISTRY_SSL_TRUSTSTORE_LOCATION` **will not override the expected location or file names**, so please follow the instructions provided or you will get this error at startup: *ERROR ==> In order to configure HTTPS access, you must mount your ssl.keystore.jks (and optionally the ssl.truststore.jks) to the /opt/bitnami/schema-registry/certs directory*.
ETisREAL marked this conversation as resolved.
Show resolved Hide resolved

Here is a docker-compose.yaml example that exposes a TLS listener on port 8082
ETisREAL marked this conversation as resolved.
Show resolved Hide resolved

``` yaml
schema-registry:
image: bitnami/schema-registry
ports:
- "8081:8081"
- "8082:8082"
depends_on:
- kafka
environment:
- SCHEMA_REGISTRY_KAFKA_BROKERS=PLAINTEXT://kafka:9092
- SCHEMA_REGISTRY_HOST_NAME=schema-registry
- SCHEMA_REGISTRY_LISTENERS=http://0.0.0.0:8081,https://0.0.0.0:8082
- SCHEMA_REGISTRY_SSL_KEYSTORE_PASSWORD=keystore
- SCHEMA_REGISTRY_SSL_TRUSTSTORE_PASSWORD=keystore
- SCHEMA_REGISTRY_SSL_ENDPOINT_IDENTIFICATION_ALGORITHM=none
- SCHEMA_REGISTRY_CLIENT_AUTHENTICATION=REQUESTED
volumes:
- ./keystore.jks:/opt/bitnami/schema-registry/certs/keystore.jks:ro
- ./truststore.jks:/opt/bitnami/schema-registry/certs/truststore.jks:ro
```

## Contributing

We'd love for you to contribute to this container. You can request new features by creating an [issue](https://github.com/bitnami/containers/issues) or submitting a [pull request](https://github.com/bitnami/containers/pulls) with your contribution.
Expand Down
Loading