From dd8938b946d42d4765e042a5ed36baa4186af17f Mon Sep 17 00:00:00 2001 From: deb-cfengine Date: Thu, 21 Nov 2013 12:32:27 -0500 Subject: [PATCH] Minor tweaks to all docs; added Feedback page to installation docs --- getting-started/installation.markdown | 11 +++++-- .../installation-community.markdown | 33 +++++++++++++++---- .../installation-enterprise-free.markdown | 12 ++++--- .../installation-enterprise-vagrant.markdown | 8 ++++- 4 files changed, 49 insertions(+), 15 deletions(-) diff --git a/getting-started/installation.markdown b/getting-started/installation.markdown index 4a0b9744..b3af1ed9 100644 --- a/getting-started/installation.markdown +++ b/getting-started/installation.markdown @@ -24,16 +24,23 @@ The following installations are available: ### CFEngine Community -Install and test the latest [version][Installing Community]. +Install and test the latest [version of Community][Installing Community]. In addition to +instructions, the section also includes simple tutorials to get you started, followed by more +advanced tutorials to help your learn the CFEngine language and functionality. ### CFEngine Enterprise +All installations feature instructions and tutorials. One tutorial teaches you how to use the +Mission Portal console; the others help your learn the CFEngine language and functionality. + +Just the installation that best suits your needs. + #### CFEngine Enterprise (Evaluation: 25 free servers) * Install and test the latest version using our pre-packaged [Vagrant environment][Installing Enterprise Vagrant Environment]. -* Install and test the latest version using our [native version][Installing Enterprise Free 25]. +* Install and test the latest version using our [native version][Installing Enterprise 25 Free]. #### CFEngine Enterprise (Production) diff --git a/getting-started/installation/installation-community.markdown b/getting-started/installation/installation-community.markdown index 79affd30..12e23843 100644 --- a/getting-started/installation/installation-community.markdown +++ b/getting-started/installation/installation-community.markdown @@ -13,10 +13,13 @@ deb packages for Ubuntu, Debian, Redhat, CentOS, and SUSE. It also provides instructions for the following: -* Install CFEngine on a Policy Server (hub) -* Bootstrap the Policy Server to itself -* Install CFEngine on a Host (client) -* Bootstrap the Host to the Policy Server +* Install CFEngine on a Policy Server (hub) and on a Host (client) +A Policy Server (hub) is a CFEngine instance that contains promises (business policy) that get deployed to Hosts. +Hosts are clients that retrieve and execute promises. +* Bootstrap the Policy Server to itself and then bootstrap the Host(s) to the Policy Server. +Bootstrapping establishes a trust relationship between the Policy Server +and all Hosts. Thus, business policy that you create in the Policy Server can be deployed to Hosts throughout your company. +Bootstrapping completes the installation process. _Tutorials, recommended reading. and production environment recommendations appear at the end of this page._ @@ -115,7 +118,7 @@ $ sudo /var/cfengine/bin/cf-agent --bootstrap Upon successful completion, a confirmation message appears: "Bootstrap to '192.168.1.12' completed successfully!" -Type the following the check what version of CFEngine your are running: +Type the following to check which version of CFEngine your are running: ``` $ /var/cfengine/bin/cf-promises --version @@ -132,7 +135,7 @@ to at least one more VM or server and it must be on the same network as the Poli ## 5. Bootstrap the Host to the Policy Server The Host(s) must be bootstrapped to the Policy Server in order to establish a connection between the Host and -the Policy Server. Run the same commands that you ran in Step 3. Note that the Policy Server and Hosts share the same IP address. +the Policy Server. Run the same commands that you ran in Step 3. ``` $ sudo /var/cfengine/bin/cf-agent --bootstrap @@ -233,10 +236,17 @@ it will pull down the latest policy update and ensure that the **example.txt** f state). In fact, any Host that has installed CFEngine will contain the **example.txt** file (because we defined the cfengine_3:: class above). +### Try these advanced tutorials: + +* [Create a standalone policy (Hello World).][Hello World] This Hello World tutorial provides more depth into how to create business policy (promises) on the +command line. Here, you can get a taste of the CFEngine language as you create standalone and executable scripts. +* [Distribute files from a central location.][Distribute files from a central location] This advanced, command-line tutorial shows +you how to distribute policy files from the Policy Server to all pertinent Hosts. + ## Recommended Reading * CFEngine [language concepts][Language Concepts] -* Tutorial: [Get CFEngine Up and Running Quickly: A Primer for New Community Users][Up and Running] +* Getting Started Tutorial: [Get CFEngine Up and Running Quickly: A Primer for New Community Users][Up and Running] ## Production Environment @@ -261,3 +271,12 @@ depends on your specific policies, especially those that concern reporting. it to allow for communication on the above ports. If applicable, type the following two commands: /`etc/init.d/iptables stop` and `chkconfig iptables off` + +
+ +## Rate your experience + +Everyone is a first-time user a some point. We want to make the CFEngine Enterprise installation process easy for all of our new users. +Before you forget your first-time experience, we would love for you to let us know how we can improve on this process. + + \ No newline at end of file diff --git a/getting-started/installation/installation-enterprise-free.markdown b/getting-started/installation/installation-enterprise-free.markdown index 32e37a90..99d19234 100644 --- a/getting-started/installation/installation-enterprise-free.markdown +++ b/getting-started/installation/installation-enterprise-free.markdown @@ -11,10 +11,12 @@ tags: [getting started, installation, enterprise free] These instructions describe how to install the latest version of CFEngine Enterprise 25 Free. This is the full version of CFEngine Enterprise, but the number of Hosts (clients) is limited to 25. -To install this version of CFEngine Enterprise, your machine must be running a recent version of Linux. -This installation script has been tested on RHEL 5 and 6, SLES 11, CentOS 5 and 6, and Debian 6 and 7. +Note the following requirements: -Note: You need a minimum of 2 GB of available memory and a modern 64 bit processor. +* To install this version of CFEngine Enterprise, your machine must be running a recent version of Linux. +This installation script has been tested on RHEL 5 and 6, SLES 11, CentOS 5 and 6, and Debian 6 and 7. +* You need a minimum of 2 GB of available memory and a modern 64 bit processor. +* You need a least two VMs/servers, one for the Policy Server and one for a Host (client). They must be on the same network. ## Installation Overview @@ -79,7 +81,7 @@ Note that this installation works on 64- and 32-bit machines. ## 4. Bootstrap the Host to the Policy Server All Hosts must be bootstrapped to the Policy Server in order to establish a connection between the Host and -the Policy Server. Run the same commands that you ran in Step 3. The Policy Server and Hosts share the same IP address. +the Policy Server. Run the same commands that you ran in Step 3. ``` $ sudo /var/cfengine/bin/cf-agent --bootstrap @@ -131,4 +133,4 @@ through the Mission Portal, this advanced, command-line tutorial shows you how t Everyone is a first-time user a some point. We want to make the CFEngine Enterprise installation process easy for all of our new users. Before you forget your first-time experience, we would love for you to let us know how we can improve on this process. - + diff --git a/getting-started/installation/installation-enterprise-vagrant.markdown b/getting-started/installation/installation-enterprise-vagrant.markdown index c91f6ff2..c46ad709 100644 --- a/getting-started/installation/installation-enterprise-vagrant.markdown +++ b/getting-started/installation/installation-enterprise-vagrant.markdown @@ -84,7 +84,6 @@ username: admin password: admin - The installation is complete! [Read on][Configure and Deploy a Policy Using Sketches (Enterprise Only)] to start your first lesson on how to use CFEngine. @@ -116,3 +115,10 @@ Vagrant and VirtualBox are useful general purpose programs, so you might want to keep them around. If not, follow the standard procedures for your OS to remove these applications. +
+## Rate your experience + +Everyone is a first-time user a some point. We want to make the CFEngine Enterprise installation process easy for all of our new users. +Before you forget your first-time experience, we would love for you to let us know how we can improve on this process. + +