Skip to content

Commit 48b5819

Browse files
authored
Update documentation and update flag for Python discovery in sample inventory (#81)
* Readability improvements to readme.adoc in cloudera-deploy * Updated example ansible inventory to force ansible_python_interpreter to 'auto' for consistent behavior on older versions of Ansible Signed-off-by: Daniel Chaffelson <chaffelson@gmail.com>
1 parent 8a24377 commit 48b5819

File tree

2 files changed

+23
-17
lines changed

2 files changed

+23
-17
lines changed

examples/sandbox/inventory_template.ini

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,3 +39,6 @@ host-1.example.com
3939
[deployment:children]
4040
cluster
4141
cloudera_manager
42+
43+
[all:vars]
44+
ansible_python_interpreter=auto

readme.adoc

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,16 @@ You can use Cloudera Deploy as your entrypoint for getting started with CDP. The
3434

3535
==== Install Docker
3636

37-
Get the latest version of **Docker Engine**.
37+
Cloudera-Deploy bundles nearly all the software dependencies you need into a convenient Docker Container, so first you will need to get the latest version of **Docker Engine**.
3838

3939
* https://docs.docker.com/docker-for-windows/install/[For Windows]
4040
* https://docs.docker.com/docker-for-mac/install/[For Macs]
4141
* Linux users, use your package manager.
4242

4343
WARNING: Be sure you uninstall any earlier versions of Docker, i.e. `docker`, and install the latest version, i.e. `docker-ce`. See https://docs.docker.com/engine/install/[Install Docker Engine] for futher details.
4444

45+
TIP: If you have not used Docker before, consider following their quick https://docs.docker.com/get-started/#start-the-tutorial[Tutorial] to validate it is working and familiarise yourself with the interface
46+
4547
==== (Optional) Install Git
4648

4749
NOTE: Git is required if you intend to clone the software for local editing, if you just intend to Run the automation tools you may skip this step.
@@ -50,19 +52,19 @@ There are excellent instructions for installing Git on all Operating Systems on
5052

5153
==== (Optional) Install AWS CLI
5254

53-
Get the latest version of the **AWS CLI**.
55+
If you are going to be working with AWS, you will want the latest version of the **AWS CLI**.
5456

5557
* https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2-windows.html[For Windows]
5658
* https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2-mac.html[For Macs]
5759
* Linux users, use your package manager.
5860

59-
NOTE: The Quickstart image prepackages the AWS CLI.
60-
61-
If this is the first time you are installing the AWS CLI, configure the program by providing your credentials.
61+
NOTE: The Quickstart image prepackages the AWS CLI, so it is optional to also install it locally
6262

63+
If this is the first time you are installing the AWS CLI, configure the program by providing your credentials, and test that your credentials work
6364
[source, bash]
6465
----
6566
aws configure
67+
aws iam get-user
6668
----
6769

6870
Visit the https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html[AWS CLI User Guide] for further details regarding credential management.
@@ -73,13 +75,14 @@ Get the latest version of the **CDP CLI**.
7375

7476
** https://docs.cloudera.com/cdp/latest/cli/topics/mc-installing-cdp-client.html[Install CDP CLI].
7577

76-
NOTE: The Quickstart image prepackages the CPI CLI.
78+
NOTE: The Quickstart image prepackages the CPI CLI, so it is optional to also install it locally
7779

78-
If this is the first time you are installing the CDP CLI, you will need to configure the program by providing the right credentials.
80+
If this is the first time you are installing the CDP CLI, you will need to configure the program by providing the right credentials, and should then test that your credentials work.
7981

8082
[source, bash]
8183
----
8284
cdp configure
85+
cdp iam get-user
8386
----
8487

8588
Visit the https://docs.cloudera.com/cdp/latest/cli/topics/mc-configuring-cdp-client-with-the-api-access-key.html[CDP CLI User Guide] for further details regarding credential management.
@@ -88,19 +91,17 @@ Visit the https://docs.cloudera.com/cdp/latest/cli/topics/mc-configuring-cdp-cli
8891

8992
Ensure that you have a generated SSH keypair for your local profile. Visit the https://www.ssh.com/academy/ssh/keygen[SSH Keygen How-To] for details.
9093

91-
NOTE: The Quickstart will generate a SSH keypair if none is provided.
94+
NOTE: The Quickstart will generate an SSH keypair if none is provided.
9295

9396
==== (Recommended) Confirm your SSH Agent
9497

9598
Ensure that you have a properly configured SSH Agent. Visit the https://www.ssh.com/academy/ssh/keygen#adding-the-key-to-ssh-agent[SSH Agent How-To] for details.
9699

97-
TIP: Put AWS CLI and CDP CLI programs in your `$PATH` to make these two programs easily accessible.
98-
99100
=== Setup
100101

101102
==== Option 1: Download the Quickstart script
102103

103-
The `quickstart.sh` script will setup the Docker container with the software dependencies you need for deployment.
104+
The `quickstart.sh` script will set up the Docker container with the software dependencies you need for deployment.
104105

105106
[source, bash]
106107
----
@@ -117,15 +118,16 @@ git clone https://github.com/cloudera-labs/cloudera-deploy.git
117118
cd cloudera-deploy
118119
----
119120

120-
WARNING: Be careful to not modify any of the files in the project as a user of the software. The vast majority of changes are managed through configurations provided to these project files.
121+
WARNING: You are advised not to modify any of the files in the project as a user of the software. The vast majority of changes are managed through configurations provided to these project files.
121122

122123
==== Confirm your Docker service
123124

124-
Check that **Docker** is running.
125+
Check that **Docker** is running by running the command to list running Docker containers
126+
127+
[source,bash]
128+
docker ps -a
125129

126-
* https://docs.docker.com/docker-for-windows/[For Windows]
127-
* https://docs.docker.com/docker-for-mac/[For Macs]
128-
* Linux users, use `systemd` (or another init system)
130+
If it is not running, please check your prerequisites process for Docker to install, start, and test the service.
129131

130132
==== Execute the Quickstart script
131133

@@ -163,7 +165,7 @@ vim ~/.config/cloudera-deploy/profiles/default
163165
* Optional
164166
** *tags* (see the link:profile.yml[profile template] comments)
165167

166-
WARNING: Please ensure you provide a valid region for the `infra_type` property.
168+
WARNING: Please ensure you provide a valid region for your selected Cloud provider for the `infra_type` property.
167169

168170
=== Execution
169171

@@ -256,6 +258,7 @@ In the cloudera-deploy directory, pull the latest changes with git
256258

257259
[source, bash]
258260
----
261+
git fetch --all
259262
git pull
260263
----
261264

0 commit comments

Comments
 (0)