https://github.com/lensesio/schema-registry-ui
Web tool for Avro Schema Registry |
https://github.com/lensesio/schema-registry-ui
avro kafka schema-registry
Last synced: 4 months ago
JSON representation
Web tool for Avro Schema Registry |
- Host: GitHub
- URL: https://github.com/lensesio/schema-registry-ui
- Owner: lensesio
- Created: 2016-06-12T13:01:38.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-02-13T15:12:45.000Z (over 1 year ago)
- Last Synced: 2024-05-23T00:15:33.475Z (over 1 year ago)
- Topics: avro, kafka, schema-registry
- Language: JavaScript
- Homepage: http://lenses.io/product/features
- Size: 10.2 MB
- Stars: 415
- Watchers: 36
- Forks: 112
- Open Issues: 39
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-kafka - schema-registry-ui
README
# schema-registry-ui
[](https://github.com/landoop/schema-registry-ui/releases/latest)
[](https://hub.docker.com/r/landoop/schema-registry-ui/)
[](https://gitter.im/Landoop/support?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
This is a web tool for the [confluentinc/schema-registry](https://github.com/confluentinc/schema-registry) in order to create / view / search / evolve / view history & configure **Avro** schemas of your Kafka cluster.
## Live Demo
[schema-registry-ui.demo.lenses.io](http://schema-registry-ui.demo.lenses.io)
## Prerequisites
You will need schema-registry installed with CORS enabled.
In order to enable CORS, add in `/opt/confluent-3.x.x/etc/schema-registry/schema-registry.properties`
```
access.control.allow.methods=GET,POST,PUT,OPTIONS
access.control.allow.origin=*
```
And then restart the [schema-registry] service
##### Get the set up locally
We also provide the schema-registry and schema-registry-ui as part of the [fast-data-dev](https://github.com/Landoop/fast-data-dev) docker image for local development setup that also gives all the relevant backends. Just run:
```
docker run -d --name=fast-data-dev -p 8081:8081 landoop/fast-data-dev
```
Checkout more about fast-data-dev docker container [here](https://github.com/Landoop/fast-data-dev)
## Running it via Docker
To run it via the provided docker image:
```
docker pull landoop/schema-registry-ui
docker run --rm -p 8000:8000 \
-e "SCHEMAREGISTRY_URL=http://confluent-schema-registry-host:port" \
landoop/schema-registry-ui
```
Please see the [docker readme](https://github.com/Landoop/schema-registry-ui/tree/master/docker) for more information
and how to enable various features or avoid CORS issues via the proxy flag.
## Build from source
```
git clone https://github.com/Landoop/schema-registry-ui.git
cd schema-registry-ui
npm install
npm start
```
Web UI will be available at `http://localhost:8080`
### Nginx config
If you use `nginx` to serve this ui, let angular manage routing with
```
location / {
try_files $uri $uri/ /index.html =404;
root /folder-with-schema-registry-ui/;
}
```
### Setup Schema Registry clusters
Use multiple schema registry clusters in `env.js` :
```
var clusters = [
{
NAME:"prod",
// Schema Registry service URL (i.e. http://localhost:8081)
SCHEMA_REGISTRY: "http://localhost:8081", // https://schema-registry.demo.landoop.com
COLOR: "#141414", // optional
readonlyMode: true // optional
},
{
NAME:"dev",
SCHEMA_REGISTRY: "http://localhost:8383",
COLOR: "red", // optional
allowGlobalConfigChanges: true, // optional
//allowTransitiveCompatibilities: true // if using a Confluent Platform release >= 3.1.1 uncomment this line
}
];
```
* Use `COLOR` to set different header colors for each set up cluster.
* Use `allowGlobalConfigChanges` to enable configuring Global Compatibility Level from the UI.
* Use `allowTransitiveCompatibilities` to enable transitive compatibility levels. This is supported in SR >= 3.1.1
* Use `allowSchemaDeletion` to enable schema deletion from the UI. This is supported in SR >= 3.3.0
* Use `readonlyMode` to prevent any configuration or schema changes from the UI. It overwrites the previous parameters (`allowGlobalConfigChanges`, `allowSchemaDeletion`).
## Changelog
[Here](https://github.com/Landoop/schema-registry-ui/wiki/Changelog)
## License
The project is licensed under the [BSL](http://www.landoop.com/bsl) license.
## Relevant Projects
* [kafka-topics-ui](https://github.com/Landoop/kafka-topics-ui), UI to browse Kafka data and work with Kafka Topics
* [kafka-connect-ui](https://github.com/Landoop/kafka-connect-ui), Set up and manage connectors for multiple connect clusters
* [fast-data-dev](https://github.com/Landoop/fast-data-dev), Docker for Kafka developers (schema-registry,kafka-rest,zoo,brokers,landoop)
* [Landoop-On-Cloudera](https://github.com/Landoop/Landoop-On-Cloudera), Install and manage your kafka streaming-platform on you Cloudera CDH cluster
www.landoop.com