This repository has been archived by the owner on May 2, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 702
Overview of Project Structure
Sam Hecht edited this page Jul 18, 2016
·
1 revision
The entrypoint /etc/confluent/docker/run
runs three executable in the /etc/confluent/docker
in the following sequence:
/etc/confluent/docker/configure
/etc/confluent/docker/ensure
/etc/confluent/docker/launch
###Configuration
The configure
script does all the configuration. This includes :
- Creating all configuration files and copying them to their proper location
- It is also responsible for handling service discovery if required.
###Preflight checks
The ensure
scripts makes sure that all the prerequisites for launching the service are in place. This includes:
- Ensure the configuration files are present and readable.
- Ensure that you can write/read to the data directory. The directories need to be world writable.
- Ensuring supporting services are in READY state. For example, ensure that ZK is ready before launching Kafka broker.
- Ensure supporting systems are configured properly. For example, make sure all topics required for C3 are created with proper replication, security and partition settings.
###Launching the process
The launch
script runs the actual process. The script should ensure that :
- The process is run properly. You need to do
exec
(Note to self: Why was this needed again?) - Log to stdout
- Make it executable
- Fail fast
- Fail with good error messages
- Return 0 if success, 1 if fail
- Introduction
-
Getting Started
- Tutorial: Running in Standalone Mode
- Tutorial: Running on Multiple Remote Hosts and Clustering
-
Security
- Overview (TODO)
- Tutorial: Enabling SSL/TLS on a Cluster
- Securing Other Components (TODO)
- Overview of image structure
- Utility Scripts
- W/ Different kinds of docker networks
- Bridged (including caveats
- host networking (including caveats)
- Enabling JMX
- Development
- Important Caveats
- How to Contribute