Quick Start: Installing and Configuring MAKara CDCatalog
Overview
This quick-start guide walks through installing MAKara CDCatalog, performing initial configuration, and verifying basic functionality so you can start cataloging change-data-capture (CDC) sources quickly.
Prerequisites
- A server or VM with Linux (Ubuntu 20.04+ or RHEL/CentOS 8+ recommended)
- Java 11+ installed (check with
java -version) - PostgreSQL 12+ (or another supported metadata store) reachable from the host
- 4+ CPU cores, 8+ GB RAM, and sufficient disk for metadata and logs
- Network access to your CDC sources (Kafka, Debezium, database replicas, etc.)
- Administrative credentials for target metadata store and any message brokers
1. Download and unpack
- SSH to your server.
- Download the MAKara CDCatalog package (assume tarball):
Code
wget https://example.com/makara-cdcatalog-.tar.gz tar -xzf makara-cdcatalog-.tar.gz cd makara-cdcatalog- - Create a service user and set ownership:
Code
sudo useradd -r -s /sbin/nologin makara sudo chown -R makara:makara /opt/makara-cdcatalog
2. Configure the metadata store
- Create a database and user in PostgreSQL:
Code
sudo -u postgres psql CREATE DATABASE makara_catalog; CREATE USER makara_user WITH ENCRYPTED PASSWORD ‘securepassword’; GRANT ALL PRIVILEGES ON DATABASE makara_catalog TO makara_user; \q - Edit the application configuration file
conf/application.yml(path may vary) and set database connection:yaml
database: driver: org.postgresql.Driver url: jdbc:postgresql://db-host:5432/makara_catalog username: makarauser password: securepassword - Run schema migrations (if provided):
Code
./bin/makara migrate
3. Configure CDC source connectors
- Open
conf/connectors.yml. - Add connector entries for your CDC sources. Example for a Debezium MySQL source:
yaml
connectors: - name: customers_mysql_debezium type: debezium config: connector.class: io.debezium.connector.mysql.MySqlConnector database.hostname: mysql-host database.port: 3306 database.user: debezium database.password: dbz-password database.server.name: mysqlcustomers table.include.list: inventory.customers - For Kafka-backed CDC, configure topic subscription and consumer group:
yaml
kafka: brokers: kafka1:9092,kafka2:9092 group.id: makara-catalog-group topics: - mysql_customers.inventory.customers
4. Set authentication and access control
- Configure admin credentials in
conf/security.yml:yaml
auth: admin_user: admin admin_password: StrongAdminPass! jwt_secret: change_this_to_a_secure_key - Optionally integrate with an external identity provider (OIDC/SAML) by editing
conf/oidc.ymland following provider-specific instructions.
5. Start the service
- Start in foreground for first-run logs:
Code
sudo -u makara ./bin/makara start - For production, install systemd unit
/etc/systemd/system/makara.service:Code
[Unit] Description=MAKara CDCatalog After=network.target[Service] User=makara ExecStart=/opt/makara-cdcatalog/bin/makara start Restart=on-failure
[Install] WantedBy=multi-user.target
Then enable and start:
Code
sudo systemctl daemon-reload sudo systemctl enable –now makara
6. Verify installation
- Check logs:
Code
sudo journalctl -u makara -f - Visit the web UI at http://:8080 (or configured port). Log in with admin credentials.
- Confirm connectors appear and are ingesting CDC events.
- Run a sample query or view cataloged schema for a recently changed table.
7. Basic troubleshooting
- Database connection errors: verify credentials, network, and that JDBC driver is present.
- Connector failures: check connector-specific logs and ensure CDC source permissions are correct.
- Authentication issues: ensure JWT secret and admin credentials match configuration.
8. Next steps (recommended)
- Secure the instance with TLS (configure reverse proxy like Nginx with TLS).
- Configure backups for PostgreSQL and application configuration.
- Set up role-based access control and SSO.
- Monitor with Prometheus/Grafana using MAKara metrics endpoint.
If you want, I can produce example configuration files for PostgreSQL, Debezium MySQL, or systemd tailored to your environment—tell me which one.
Leave a Reply