You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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>
Copy file name to clipboardExpand all lines: readme.adoc
+20-17Lines changed: 20 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,14 +34,16 @@ You can use Cloudera Deploy as your entrypoint for getting started with CDP. The
34
34
35
35
==== Install Docker
36
36
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**.
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.
44
44
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
+
45
47
==== (Optional) Install Git
46
48
47
49
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
50
52
51
53
==== (Optional) Install AWS CLI
52
54
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**.
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
62
62
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
63
64
[source, bash]
64
65
----
65
66
aws configure
67
+
aws iam get-user
66
68
----
67
69
68
70
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**.
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
77
79
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.
79
81
80
82
[source, bash]
81
83
----
82
84
cdp configure
85
+
cdp iam get-user
83
86
----
84
87
85
88
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
88
91
89
92
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.
90
93
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.
92
95
93
96
==== (Recommended) Confirm your SSH Agent
94
97
95
98
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.
96
99
97
-
TIP: Put AWS CLI and CDP CLI programs in your `$PATH` to make these two programs easily accessible.
98
-
99
100
=== Setup
100
101
101
102
==== Option 1: Download the Quickstart script
102
103
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.
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.
121
122
122
123
==== Confirm your Docker service
123
124
124
-
Check that **Docker** is running.
125
+
Check that **Docker** is running by running the command to list running Docker containers
0 commit comments