From 6fd986755d1fd8668bf64af95a17e512da5bc1d0 Mon Sep 17 00:00:00 2001 From: "Simental Magana, Marcos" Date: Fri, 11 Nov 2016 14:20:31 -0600 Subject: [PATCH 1/2] ciao-deploy: use ciao provided ansible playbooks Since the ciao examples to deploy were moved from https://github.com/clearlinux/clear-config-management to https://github.com/01org/ciao/, the instructions should tell the user to use the ciao ones instead of deprecated clear-config-management. Signed-off-by: Simental Magana, Marcos --- source/ciao-deploy.rst | 27 ++++++++++++++++----------- 1 file changed, 16 insertions(+), 11 deletions(-) diff --git a/source/ciao-deploy.rst b/source/ciao-deploy.rst index 498c7dfb..e987f9ac 100644 --- a/source/ciao-deploy.rst +++ b/source/ciao-deploy.rst @@ -45,14 +45,14 @@ You will need to download the ciao example deployment as follows: .. code-block:: console - $ git clone https://github.com/clearlinux/clear-config-management.git + $ git clone https://github.com/01org/ciao.git Once you're cloned the repo, continue working in the -`clear-config-management/examples/ciao/` directory +`ciao/_DeploymentAndDistroPackaging/ansible/` directory .. code-block:: console - # cd $(pwd)/clear-config-management/examples/ciao/ + # cd $(pwd)/ciao/_DeploymentAndDistroPackaging/ansible/ Next, edit the configuration files for the cluster: @@ -69,7 +69,7 @@ Next, edit the configuration files for the cluster: A full list of available variables can be found in the :file:`defaults/main.yml` file of each role at -https://github.com/clearlinux/clear-config-management/tree/master/roles. +https://github.com/01org/ciao/tree/master/_DeploymentAndDistroPackaging/ansible/roles. To start your cluster setup, we provide a ready-to-use Docker container. Simply download it and run your setup: @@ -83,22 +83,27 @@ You can later launch the container with: .. code-block:: console - $ docker run --privileged -v /path/to/your/.ssh/key:/root/.ssh/id_rsa \ - -v $(pwd)/clear-config-management/examples/ciao:/root/ciao \ + $ docker run --privileged -v /dev/:/dev/ + -v /path/to/your/.ssh/key:/root/.ssh/id_rsa \ + -v $(pwd)/ciao:/root/ciao \ -it clearlinux/ciao-deploy -Note: Container is called in `privileged` mode in order to install your -certificates in the CNCI image. to learn more about the Docker options used, -please refer to the `Docker* documentation`_. +Note: Container is called in `privileged` mode mounting /dev/ in order to +install your certificates in the CNCI image, this is done by using loops. +To learn more about the Docker options used, please refer to the +`Docker* documentation`_. Run the playbook ================ -Once the variables and hosts file are configured, start deployment -with the following command: +Once the variables and hosts file are configured, continue in the +`/root/ciao/_DeploymentAndDistroPackaging/ansible` directory and +start the deployment: .. code-block:: console + # cd /root/ciao/_DeploymentAndDistroPackaging/ansible + # ansible-playbook -i hosts ciao.yml \ --private-key=~/.ssh/id_rsa \ --user= From bad08e45929ac4f37cf6373ac457c9b294d88f01 Mon Sep 17 00:00:00 2001 From: "Simental Magana, Marcos" Date: Mon, 14 Nov 2016 11:43:37 -0600 Subject: [PATCH 2/2] ciao-deploy: use the `.. note::` rst directive Signed-off-by: Simental Magana, Marcos --- source/ciao-deploy.rst | 39 +++++++++++++++++++++++---------------- 1 file changed, 23 insertions(+), 16 deletions(-) diff --git a/source/ciao-deploy.rst b/source/ciao-deploy.rst index e987f9ac..7dcdcea7 100644 --- a/source/ciao-deploy.rst +++ b/source/ciao-deploy.rst @@ -22,8 +22,10 @@ For this example, we'll use a total of five nodes: - Two `compute nodes`_, which will spawn the VMs and containers. - A `network node`_ which will handle the networking for the workloads. - Note: The deployment machine is not a necessary part of the cluster; it could be - the sysadmin's computer or a CI/CD server. +.. note:: + + The deployment machine is not a necessary part of the cluster; it could be + the sysadmin's computer or a CI/CD server. .. _prerequisites: @@ -88,10 +90,12 @@ You can later launch the container with: -v $(pwd)/ciao:/root/ciao \ -it clearlinux/ciao-deploy -Note: Container is called in `privileged` mode mounting /dev/ in order to -install your certificates in the CNCI image, this is done by using loops. -To learn more about the Docker options used, please refer to the -`Docker* documentation`_. +.. note:: + + The cotainer needs `--privileged -v /dev/:/dev/` in order to + install your certificates in the `CNCI image`_. + To learn more about the Docker options used, please refer to the + `Docker* documentation`_. Run the playbook @@ -108,20 +112,22 @@ start the deployment: --private-key=~/.ssh/id_rsa \ --user= -Note: The playbook will create the following files in the current folder of -the machine running the playbooks. +.. note:: - * ``./certificates``: This directory contains the certificates - that where created and copied to the cluster nodes. + Note: The playbook will create the following files in the current folder of + the machine running the playbooks. - * ``./images``: This directory contains the images used by the - ciao cluster (fedora, clearlinux, cnci, ovmf.fd). + * ``./certificates``: This directory contains the certificates + that where created and copied to the cluster nodes. - * ``./ciaorc``: This file contains environment variables needed - by ciao cli to authenticate to the ciao cluster. + * ``./images``: This directory contains the images used by the + ciao cluster (fedora, clearlinux, cnci, ovmf.fd). - * ``./openrc``: This file contains environment variables needed by - openstack cli to authenticate with the ciao cluster. + * ``./ciaorc``: This file contains environment variables needed + by ciao cli to authenticate to the ciao cluster. + + * ``./openrc``: This file contains environment variables needed by + openstack cli to authenticate with the ciao cluster. Verify ====== @@ -168,4 +174,5 @@ Then you could verify with the following command: .. _hosts: https://github.com/clearlinux/clear-config-management/blob/master/examples/ciao/hosts .. _groups_vars/all: https://github.com/clearlinux/clear-config-management/blob/master/examples/ciao/group_vars/all .. _github: https://github.com/clearlinux/clear-config-management/tree/master/examples/ciao +.. _CNCI image: https://github.com/01org/ciao/tree/master/networking/ciao-cnci-agent#cnci-agent .. _Docker* documentation: https://docs.docker.com/engine/reference/commandline/run/