Skip to content

Commit b92be7f

Browse files
author
Nikoleta Verbeck
committed
Updated to README
1 parent 621efb5 commit b92be7f

File tree

1 file changed

+41
-39
lines changed

1 file changed

+41
-39
lines changed

Diff for: ‎README.md

+41-39
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,54 @@ Terraform Module(s) for Deploying the Confluent Platform within AWS.
44

55
# Features
66

7-
## Feature Metric
8-
9-
| CP Component | EC2 Instance | EBS Volumes | Route53 DNS | Security Groups | Load Balancers | Multi AZ | Auto Scaling Groups | Multi Cluster | Monitoring |
10-
|:--------------- |:------------:|:-----------:|:-----------:|:---------------:|:--------------:|:--------:|:-------------------:|:-------------:|:----------:|
11-
| Zookeeper | X | X | X | X | N/A | X | N/A | N/A | X |
12-
| Kafka Broker | X | X | X | X | | X | N/A | N/A | X |
13-
| Kafka Connect | X | X | X | X | | X | | | X |
14-
| ksqlDB | X | X | X | X | | X | | | X |
15-
| Rest Proxy | X | X | X | X | | X | | N/A | X |
16-
| Schema Registry | X | X | X | X | | X | N/A | N/A | X |
17-
| Control Center | X | X | X | X | N/A | X | N/A | N/A | X |
7+
| | Zookeeper | Kafka Broker | Kafka Connect | ksqlDB | Rest Proxy | Schema Registry | Control Center |
8+
|:------------------- |:---------:|:------------:|:-------------:|:------:|:----------:|:---------------:|:--------------:|
9+
| EC2 Instance | X | X | X | X | X | X | X |
10+
| EBS Volumes | X | X | X | X | X | X | X |
11+
| Route53 DNS | X | X | X | X | X | X | X |
12+
| Security Groups | X | X | X | X | X | X | X |
13+
| Load Balancers | N/A | | | | | | N/A |
14+
| Multi AZ | X | X | X | X | X | X | X |
15+
| Auto Scaling Groups | N/A | N/A | | | | N/A | N/A |
16+
| Multi Cluster | N/A | N/A | | | N/A | N/A | N/A |
17+
| Monitoring | X | X | X | X | X | X | X |
18+
| EC2 User Data | X | X | X | X | X | X | X |
1819

1920
## Feature Limitations
2021

2122
1. Out of the box all nodes and security groups are required to live in the same VPC
2223

23-
NOTE: If you leverage the individual component modules, some of these limitations can be worked around.
24+
**NOTE:** If you leverage the individual component modules, some of these limitations can be worked around.
2425
These limitation just haven't be able to be baked into a single unified parent module yet, or may not be possible to at all.
2526

26-
## Defining separate providers
27+
## Monitoring
28+
29+
Currently Prometheus and Jolokia are the only supported monitoring platforms.
30+
The contained features around them will Setup Security Groups and EC2 instance tags appropriate to each component.
31+
The EC2 tags are designed to allow you to use Prometheus' EC2 Service Discovery feature,
32+
[as discussed here](https://medium.com/investing-in-tech/automatic-monitoring-for-all-new-aws-instances-using-prometheus-service-discovery-97d37a5b2ea2),
33+
to find each component and automaticly start reading from that component.
34+
35+
# Pre-Defined Template Varaibles
36+
37+
| Variable | Availability | Desc |
38+
|:---------------------|:---------------|:-----|
39+
| node_count | ALL | Node index within the component's collection of nodes |
40+
| component_name | ALL | Full name of component. Ex: `Control Center`, `Zookeeper`, `Kafka Broker` |
41+
| component_short_name | ALL | Short name of component. Ex: `c3`, `zk`, `kfk`, `sr` |
42+
| node_name | DNS, User_Data | The rendered node name template for the given instance |
43+
| node_dns | User_Data | The rendered node DNS template for the given instance |
44+
| node_devices | User_Data | Comma separated list of devices/volumes that will be attached to this instance |
45+
46+
# How To
47+
48+
## Provide User Data to EC2 Instances
49+
50+
Each component has support to render a template and use that as the `user_data` that gets provided to created instances.
51+
These templates will be given a default set of varaibles, as outlined above, as well as any variables you add to the `extra_template_vars`, `*_extra_template_vars`, `user_data_template_vars`, `*_user_data_template_vars` variables.
52+
Of note, the `extra_template_vars` and `user_data_template_vars` are treated as global collections, and will be provided to all components/sub_modules.
53+
54+
## Defining Separate Providers
2755

2856
As of 2.4.3 you can now define separate providers for your EC2 instance creation and your DNS creation.
2957
This is to support those users that may need to use separate IAM accounts to for DNS then they do to create EC2, EBS, and SecGroups.
@@ -55,29 +83,3 @@ module "shared-cp-aws" {
5583
}
5684
```
5785

58-
## Monitoring
59-
60-
Currently Prometheus and Jolokia are the only supported monitoring platforms.
61-
The contained features around them will Setup Security Groups and EC2 instance tags appropriate to each component.
62-
The EC2 tags are designed to allow you to use Prometheus' EC2 Service Discovery feature,
63-
[as discussed here](https://medium.com/investing-in-tech/automatic-monitoring-for-all-new-aws-instances-using-prometheus-service-discovery-97d37a5b2ea2),
64-
to find each component and automaticly start reading from that component.
65-
66-
# How To
67-
68-
## Provide User Data to EC2 Instances
69-
70-
Each component has support to render a template and use that as the `user_data` that gets provided to created instances.
71-
These templates will be given a default set of varaibles, as outlined below, as well as any variables you add to the `extra_template_vars`, `*_extra_template_vars`, `user_data_template_vars`, `*_user_data_template_vars` variables.
72-
Of note, the `extra_template_vars` and `user_data_template_vars` are treated as global collections, and will be provided to all components/sub_modules.
73-
74-
# Pre-Defined Template Varaibles
75-
76-
| Variable | Availability | Desc |
77-
|:---------------------|:---------------|:-----|
78-
| node_count | ALL | Node index within the component's collection of nodes |
79-
| component_name | ALL | Full name of component. Ex: `Control Center`, `Zookeeper`, `Kafka Broker` |
80-
| component_short_name | ALL | Short name of component. Ex: `c3`, `zk`, `kfk`, `sr` |
81-
| node_name | DNS, User_Data | The rendered node name template for the given instance |
82-
| node_dns | User_Data | The rendered node DNS template for the given instance |
83-
| node_devices | User_Data | Comma separated list of devices/volumes that will be attached to this instance |

0 commit comments

Comments
 (0)