diff --git a/README.md b/README.md index c787ec0..b7f7f64 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ TLS Catalog - [kubernetes](https://github.com/Capgemini/tf_tls/tree/master/kubernetes) - TLS certs for APIserver, worker and admin key - [etcd](https://github.com/Capgemini/tf_tls/tree/master/etcd) - - TLS certs etcd + - TLS certs for etcd Usage ------ diff --git a/ca/README.md b/ca/README.md index 5b7c81a..d8f87a4 100644 --- a/ca/README.md +++ b/ca/README.md @@ -23,7 +23,7 @@ Input Variables `ssh_private_key` - Private key to ssh into the hosts. -`target_folder` - Folder to upload the the CA. +`target_folder` - Folder to upload the CA. `user` - User for the target folder. diff --git a/docker/README.md b/docker/README.md index e7374a3..03a1b35 100644 --- a/docker/README.md +++ b/docker/README.md @@ -1,6 +1,6 @@ tf_docker_ca ========== -A Terraform module for creating the docker CA configuration so your docker client can connect to yor docker daemon in a secure manner on TLS +A Terraform module for creating the docker CA configuration so your docker client can connect to your docker daemon in a secure manner on TLS See: https://docs.docker.com/engine/security/https/ @@ -14,7 +14,7 @@ Docker daemon: `ca_private_key_pem` - PEM-encoded private key data for the CA. This can be read from a separate file using the file interpolation function. -`ip_addresses_list` - List of DNS names for which a certificate is being requested. +`ip_addresses_list` - List of IP addresses for which a certificate is being requested. `docker_daemon_count` - Number of machines to set up the certificates @@ -57,7 +57,7 @@ module "docker_client_certs" { } ``` -Assuming you docker daemon is configured to use the certificates ```--tlsverify --tlscacert=/etc/docker/ca.pem --tlscert=/etc/docker/server.pem --tlskey=/etc/docker/server-key.pem```, you can test it from on of the clients by running: +Assuming your docker daemon is configured to use the certificates ```--tlsverify --tlscacert=/etc/docker/ca.pem --tlscert=/etc/docker/server.pem --tlskey=/etc/docker/server-key.pem```, you can test it from one of the clients by running: ``` export DOCKER_HOST=tcp://$HOST:2376 DOCKER_TLS_VERIFY=1 diff --git a/etcd/README.md b/etcd/README.md index df581e8..7e4eef6 100644 --- a/etcd/README.md +++ b/etcd/README.md @@ -1,7 +1,7 @@ Etcd TLS terraform module ======================= -A terraform module with contains TLS certificates for etcd. +A terraform module which contains TLS certificates for etcd. Usage ----- @@ -16,7 +16,7 @@ module "etcd" { ca_cert_pem = "/ca/cert_pem" # CA cert PEM ca_private_key_pem = "/ca/private_key" # CA private key validity_period_hours = "8760" # hours of cert validity - early_renewal_hours" = "720" # hours of cert renewal + early_renewal_hours = "720" # hours of cert renewal } ``` diff --git a/kubernetes/README.md b/kubernetes/README.md index cf03e6b..0cfb5e2 100644 --- a/kubernetes/README.md +++ b/kubernetes/README.md @@ -1,7 +1,7 @@ Kubernetes TLS terraform module ======================= -A terraform module with contains TLS certificates for Kubernetes master, worker +A terraform module which contains TLS certificates for Kubernetes master, worker and admin key. Certs @@ -26,9 +26,9 @@ module "k8s_worker" { ca_private_key_pem = "/ca/private_key" # CA private key worker_count = 1 # number of worker instances validity_period_hours = "8760" # hours of cert validity - early_renewal_hours" = "720" # hours of cert renewal + early_renewal_hours = "720" # hours of cert renewal ssh_user = "core" # ssh user for ip_addresses - ssh_private_key" = "/ssh/private_key" # ssh private key for ip_addresses + ssh_private_key = "/ssh/private_key" # ssh private key for ip_addresses } @@ -39,9 +39,9 @@ module "k8s_admin" { ca_private_key_pem = "/ca/private_key" # CA private key worker_count = 1 # number of worker instances validity_period_hours = "8760" # hours of cert validity - early_renewal_hours" = "720" # hours of cert renewal + early_renewal_hours = "720" # hours of cert renewal ssh_user = "core" # ssh user for ip_addresses - ssh_private_key" = "/ssh/private_key" # ssh private key for ip_addresses + ssh_private_key = "/ssh/private_key" # ssh private key for ip_addresses } ```