diff --git a/README.md b/README.md index 48755a7d7..003c4c112 100644 --- a/README.md +++ b/README.md @@ -61,7 +61,7 @@ Following parameters are available to customize the elastic cluster: The default image used adds TLS to the Elastic cluster. If not existing, secrets are automatically generated by the operator dynamically. -If supplying your own certs, first generate them and add to a secret. Secret should contain `truststore.jks` and `node-keystore.jks`. The name of the secret should follow the pattern: `es-certs-[ClusterName]`. So for example if your cluster is named `example-es-cluster` then the secret should be `es-certs-example-es-cluster. +If supplying your own certs, first generate them and add to a secret. Secret should contain `truststore.jks` and `node-keystore.jks`. The name of the secret should follow the pattern: `es-certs-[ClusterName]`. So for example if your cluster is named `example-es-cluster` then the secret should be `es-certs-example-es-cluster`. ## Base image @@ -107,6 +107,8 @@ _NOTE: In the example we're putting the operator into the namespace `operator`. # Create Example ElasticSearch Cluster +Run the following command to create a [sample cluster](example/example-es-cluster.yaml) on AWS and you most likely will have to update the [zones](example/example-es-cluster.yaml#L16) to match your AWS Account, other examples are available as well if not running on AWS: + ```bash $ kubectl create -n operator -f https://raw.githubusercontent.com/upmc-enterprises/elasticsearch-operator/master/example/example-es-cluster.yaml ``` @@ -246,7 +248,7 @@ spec: # Access Cluster -Once deployed and all pods are running, the cluster can be accessed internally via https://elasticsearch:9200/ or https://${ELASTICSEARCH_SERVICE_HOST}:9200/ +Once deployed and all pods are running, the cluster can be accessed internally via `https://elasticsearch:9200/` or `https://${ELASTICSEARCH_SERVICE_HOST}:9200/` ![alt text](docs/images/running-cluster.png "Running Cluster")