Skip to content

Commit 2dfd1a0

Browse files
committed
Update default SSH host key checking, user warnings, and documentation
Signed-off-by: Webster Mudge <wmudge@cloudera.com>
1 parent f86c50c commit 2dfd1a0

File tree

2 files changed

+33
-1
lines changed

2 files changed

+33
-1
lines changed

quickstart.sh

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,17 @@ if [ ! "$(docker ps -q -f name=${CONTAINER_NAME})" ]; then
8585
docker exec -td "${CONTAINER_NAME}" /usr/bin/env git clone https://github.com/cloudera-labs/cloudera-deploy.git /opt/cloudera-deploy --depth 1
8686
fi
8787

88+
cat <<SSH_HOST_KEY
89+
90+
*** WARNING: SSH Host Key Checking is disabled by default. ***
91+
92+
This setting may not be suitable for Production deployments.
93+
If you wish to enable host key checking, please set the Ansible environment
94+
variable, ANSIBLE_HOST_KEY_CHECKING, to True before execution. See the project
95+
documentation for further details on managing SSH host key checking.
96+
97+
SSH_HOST_KEY
98+
8899
echo 'Quickstart? Run this command -- ansible-playbook /opt/cloudera-deploy/main.yml -e "definition_path=examples/sandbox" -t run,default_cluster'
89100
docker exec \
90101
--detach-keys="ctrl-@" \

readme.adoc

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
*Automation wrappers for the Cloudera Ansible Collection*
66

7-
Readme last updated: 2021-05-03
7+
Readme last updated: 2021-05-10
88

99
Cloudera Deploy is a toolset for deploying the Cloudera Data Platform (CDP). It's scope includes both Public and Private Cloud products and Base clusters, and application setup, execution and other post-deployment functions.
1010

@@ -104,6 +104,27 @@ For CDP Private Cloud you will need a valid Cloudera license file in order to do
104104

105105
If you are also using Public Cloud infrastructure to host your CDP Private Cloud clusters, then you will need those credentials as well.
106106

107+
== SSH Host Key Checking
108+
109+
For CDP Private Cloud clusters and other direct inventory scenarios, you will need to manage SSH host key validation appropriate to your specific environment.
110+
111+
**Be advised!** By default, the `quickstart.sh` script explicitly sets the `ANSIBLE_HOST_KEY_CHECKING` variable to `False` for ease-of-use with an introductory deployment. However, this setting is *not recommended* for any other deployment type. **For all other deployment types, you should directly manage your SSH host key checking.**
112+
113+
A common approach is to create your own "startup" script using the `quickstart.sh` as a template, and setting the appropriate https://docs.ansible.com/ansible/latest/reference_appendices/config.html[Ansible SSH configuration variables].
114+
115+
In some scenarios, for example, a reused pool of dynamic hosts within a development Openstack environment, you might wish to manage this control from your host machine's SSH config file. For example:
116+
117+
[source]
118+
----
119+
# ~/.ssh/config
120+
121+
# Disable host key checking only for your specific environment
122+
Host *.your.development.domain
123+
StrictHostKeyChecking no
124+
----
125+
126+
These settings will flow from your host to the Docker container's environment.
127+
107128
== Execution
108129

109130
Cloudera Deploy utilizes a single entrypoint playbook -- `main.yml` -- that examines the user-provided <<User Input Dependencies,profile>> details, a deployment <<Definitions, definition>>, and any optional Ansible `tags` and then runs the appropriate actions. At minimum, you execute a deployment like so:

0 commit comments

Comments
 (0)