X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?p=stor4nfv.git;a=blobdiff_plain;f=ci%2Fansible%2FREADME.md;h=1bda3b3d793525baff580c0a900d13ba0a76c1c8;hp=2bf2a804ea41785b5a8f3b7032f59c264cf053ab;hb=b9f16e2669ff5a0cde006951ffec5dff84ac29df;hpb=561c0708b78eed8120b90f0221cd66730c9e8a74 diff --git a/ci/ansible/README.md b/ci/ansible/README.md old mode 100644 new mode 100755 index 2bf2a80..1bda3b3 --- a/ci/ansible/README.md +++ b/ci/ansible/README.md @@ -1,178 +1,178 @@ -# opensds-ansible -This is an installation tool for opensds using ansible. - -## 1. How to install an opensds local cluster -This installation document assumes there is a clean Ubuntu 16.04 environment. If golang is already installed in the environment, make sure the following parameters are configured in ```/etc/profile``` and run ``source /etc/profile``: -```conf -export GOROOT=/usr/local/go -export GOPATH=$HOME/gopath -export PATH=$PATH:$GOROOT/bin:$GOPATH/bin -``` - -### Pre-config (Ubuntu 16.04) -First download some system packages: -``` -sudo apt-get install -y openssh-server git make gcc -``` -Then config ```/etc/ssh/sshd_config``` file and change one line: -```conf -PermitRootLogin yes -``` -Next generate ssh-token: -```bash -ssh-keygen -t rsa -ssh-copy-id -i ~/.ssh/id_rsa.pub # IP address of the target machine of the installation -``` - -### Install docker -If use a standalone cinder as backend, you also need to install docker to run cinder service. Please see the [docker installation document](https://docs.docker.com/engine/installation/linux/docker-ce/ubuntu/) for details. - -### Install ansible tool -```bash -sudo add-apt-repository ppa:ansible/ansible # This step is needed to upgrade ansible to version 2.4.2 which is required for the ceph backend. -sudo apt-get update -sudo apt-get install ansible -ansible --version # Ansible version 2.4.2 or higher is required for ceph; 2.0.0.2 or higher is needed for other backends. -``` - -### Download opensds source code -```bash -mkdir -p $HOME/gopath/src/github.com/opensds && cd $HOME/gopath/src/github.com/opensds -git clone https://github.com/opensds/opensds.git -b -cd opensds/contrib/ansible -``` - -### Configure opensds cluster variables: -##### System environment: -Configure the ```workplace``` in `group_vars/common.yml`: -```yaml -workplace: /home/your_username # Change this field according to your username. If login as root, configure this parameter to '/root' -``` - -##### LVM -If `lvm` is chosen as storage backend, modify `group_vars/osdsdock.yml`: -```yaml -enabled_backend: lvm # Change it according to the chosen backend. Supported backends include 'lvm', 'ceph', and 'cinder' -pv_device: "your_pv_device_path" # Specify a block device and ensure it exists if lvm is chosen -vg_name: "specified_vg_name" # Specify a name for VG if choosing lvm -``` -Modify ```group_vars/lvm/lvm.yaml```, change pool name to be the same as `vg_name` above: -```yaml -"vg001" # change pool name to be the same as vg_name -``` -##### Ceph -If `ceph` is chosen as storage backend, modify `group_vars/osdsdock.yml`: -```yaml -enabled_backend: ceph # Change it according to the chosen backend. Supported backends include 'lvm', 'ceph', and 'cinder'. -ceph_pool_name: "specified_pool_name" # Specify a name for ceph pool if choosing ceph -``` -Modify ```group_vars/ceph/ceph.yaml```, change pool name to be the same as `ceph_pool_name`: -```yaml -"rbd" # change pool name to be the same as ceph pool -``` -Configure two files under ```group_vars/ceph```: `all.yml` and `osds.yml`. Here is an example: - -```group_vars/ceph/all.yml```: -```yml -ceph_origin: repository -ceph_repository: community -ceph_stable_release: luminous # Choose luminous as default version -public_network: "192.168.3.0/24" # Run 'ip -4 address' to check the ip address -cluster_network: "{{ public_network }}" -monitor_interface: eth1 # Change to the network interface on the target machine -``` -```group_vars/ceph/osds.yml```: -```yml -devices: # For ceph devices, append one or multiple devices like the example below: - - '/dev/sda' # Ensure this device exists and available if ceph is chosen - - '/dev/sdb' # Ensure this device exists and available if ceph is chosen -osd_scenario: collocated -``` - -##### Cinder -If `cinder` is chosen as storage backend, modify `group_vars/osdsdock.yml`: -```yaml -enabled_backend: cinder # Change it according to the chosen backend. Supported backends include 'lvm', 'ceph', and 'cinder' - -# Use block-box install cinder_standalone if true, see details in: -use_cinder_standalone: true -# If true, you can configure cinder_container_platform, cinder_image_tag, -# cinder_volume_group. - -# Default: debian:stretch, and ubuntu:xenial, centos:7 is also supported. -cinder_container_platform: debian:stretch -# The image tag can be arbitrarily modified, as long as follow the image naming -# conventions, default: debian-cinder -cinder_image_tag: debian-cinder -# The cinder standalone use lvm driver as default driver, therefore `volume_group` -# should be configured, the default is: cinder-volumes. The volume group will be -# removed when use ansible script clean environment. -cinder_volume_group: cinder-volumes -``` - -Configure the auth and pool options to access cinder in `group_vars/cinder/cinder.yaml`. Do not need to make additional configure changes if using cinder standalone. - -### Check if the hosts can be reached -```bash -sudo ansible all -m ping -i local.hosts -``` - -### Run opensds-ansible playbook to start deploy -```bash -sudo ansible-playbook site.yml -i local.hosts -``` - -## 2. How to test opensds cluster - -### Configure opensds CLI tool -```bash -sudo cp $GOPATH/src/github.com/opensds/opensds/build/out/bin/osdsctl /usr/local/bin -export OPENSDS_ENDPOINT=http://127.0.0.1:50040 -osdsctl pool list # Check if the pool resource is available -``` - -### Create a default profile first. -``` -osdsctl profile create '{"name": "default", "description": "default policy"}' -``` - -### Create a volume. -``` -osdsctl volume create 1 --name=test-001 -``` -For cinder, az needs to be specified. -``` -osdsctl volume create 1 --name=test-001 --az nova -``` - -### List all volumes. -``` -osdsctl volume list -``` - -### Delete the volume. -``` -osdsctl volume delete -``` - - -## 3. How to purge and clean opensds cluster - -### Run opensds-ansible playbook to clean the environment -```bash -sudo ansible-playbook clean.yml -i local.hosts -``` - -### Run ceph-ansible playbook to clean ceph cluster if ceph is deployed -```bash -cd /opt/ceph-ansible -sudo ansible-playbook infrastructure-playbooks/purge-cluster.yml -i ceph.hosts -``` - -In addition, clean up the logical partition on the physical block device used by ceph, using the ```fdisk``` tool. - -### Remove ceph-ansible source code (optional) -```bash -cd .. -sudo rm -rf /opt/ceph-ansible -``` +# opensds-ansible +This is an installation tool for opensds using ansible. + +## 1. How to install an opensds local cluster +This installation document assumes there is a clean Ubuntu 16.04 environment. If golang is already installed in the environment, make sure the following parameters are configured in ```/etc/profile``` and run ``source /etc/profile``: +```conf +export GOROOT=/usr/local/go +export GOPATH=$HOME/gopath +export PATH=$PATH:$GOROOT/bin:$GOPATH/bin +``` + +### Pre-config (Ubuntu 16.04) +First download some system packages: +``` +sudo apt-get install -y openssh-server git make gcc +``` +Then config ```/etc/ssh/sshd_config``` file and change one line: +```conf +PermitRootLogin yes +``` +Next generate ssh-token: +```bash +ssh-keygen -t rsa +ssh-copy-id -i ~/.ssh/id_rsa.pub # IP address of the target machine of the installation +``` + +### Install docker +If use a standalone cinder as backend, you also need to install docker to run cinder service. Please see the [docker installation document](https://docs.docker.com/engine/installation/linux/docker-ce/ubuntu/) for details. + +### Install ansible tool +```bash +sudo add-apt-repository ppa:ansible/ansible # This step is needed to upgrade ansible to version 2.4.2 which is required for the ceph backend. +sudo apt-get update +sudo apt-get install ansible +ansible --version # Ansible version 2.4.2 or higher is required for ceph; 2.0.0.2 or higher is needed for other backends. +``` + +### Download opensds source code +```bash +mkdir -p $HOME/gopath/src/github.com/opensds && cd $HOME/gopath/src/github.com/opensds +git clone https://github.com/opensds/opensds.git -b +cd opensds/contrib/ansible +``` + +### Configure opensds cluster variables: +##### System environment: +Configure the ```workplace``` in `group_vars/common.yml`: +```yaml +workplace: /home/your_username # Change this field according to your username. If login as root, configure this parameter to '/root' +``` + +##### LVM +If `lvm` is chosen as storage backend, modify `group_vars/osdsdock.yml`: +```yaml +enabled_backend: lvm # Change it according to the chosen backend. Supported backends include 'lvm', 'ceph', and 'cinder' +pv_device: "your_pv_device_path" # Specify a block device and ensure it exists if lvm is chosen +vg_name: "specified_vg_name" # Specify a name for VG if choosing lvm +``` +Modify ```group_vars/lvm/lvm.yaml```, change pool name to be the same as `vg_name` above: +```yaml +"vg001" # change pool name to be the same as vg_name +``` +##### Ceph +If `ceph` is chosen as storage backend, modify `group_vars/osdsdock.yml`: +```yaml +enabled_backend: ceph # Change it according to the chosen backend. Supported backends include 'lvm', 'ceph', and 'cinder'. +ceph_pool_name: "specified_pool_name" # Specify a name for ceph pool if choosing ceph +``` +Modify ```group_vars/ceph/ceph.yaml```, change pool name to be the same as `ceph_pool_name`: +```yaml +"rbd" # change pool name to be the same as ceph pool +``` +Configure two files under ```group_vars/ceph```: `all.yml` and `osds.yml`. Here is an example: + +```group_vars/ceph/all.yml```: +```yml +ceph_origin: repository +ceph_repository: community +ceph_stable_release: luminous # Choose luminous as default version +public_network: "192.168.3.0/24" # Run 'ip -4 address' to check the ip address +cluster_network: "{{ public_network }}" +monitor_interface: eth1 # Change to the network interface on the target machine +``` +```group_vars/ceph/osds.yml```: +```yml +devices: # For ceph devices, append one or multiple devices like the example below: + - '/dev/sda' # Ensure this device exists and available if ceph is chosen + - '/dev/sdb' # Ensure this device exists and available if ceph is chosen +osd_scenario: collocated +``` + +##### Cinder +If `cinder` is chosen as storage backend, modify `group_vars/osdsdock.yml`: +```yaml +enabled_backend: cinder # Change it according to the chosen backend. Supported backends include 'lvm', 'ceph', and 'cinder' + +# Use block-box install cinder_standalone if true, see details in: +use_cinder_standalone: true +# If true, you can configure cinder_container_platform, cinder_image_tag, +# cinder_volume_group. + +# Default: debian:stretch, and ubuntu:xenial, centos:7 is also supported. +cinder_container_platform: debian:stretch +# The image tag can be arbitrarily modified, as long as follow the image naming +# conventions, default: debian-cinder +cinder_image_tag: debian-cinder +# The cinder standalone use lvm driver as default driver, therefore `volume_group` +# should be configured, the default is: cinder-volumes. The volume group will be +# removed when use ansible script clean environment. +cinder_volume_group: cinder-volumes +``` + +Configure the auth and pool options to access cinder in `group_vars/cinder/cinder.yaml`. Do not need to make additional configure changes if using cinder standalone. + +### Check if the hosts can be reached +```bash +sudo ansible all -m ping -i local.hosts +``` + +### Run opensds-ansible playbook to start deploy +```bash +sudo ansible-playbook site.yml -i local.hosts +``` + +## 2. How to test opensds cluster + +### Configure opensds CLI tool +```bash +sudo cp $GOPATH/src/github.com/opensds/opensds/build/out/bin/osdsctl /usr/local/bin +export OPENSDS_ENDPOINT=http://127.0.0.1:50040 +osdsctl pool list # Check if the pool resource is available +``` + +### Create a default profile first. +``` +osdsctl profile create '{"name": "default", "description": "default policy"}' +``` + +### Create a volume. +``` +osdsctl volume create 1 --name=test-001 +``` +For cinder, az needs to be specified. +``` +osdsctl volume create 1 --name=test-001 --az nova +``` + +### List all volumes. +``` +osdsctl volume list +``` + +### Delete the volume. +``` +osdsctl volume delete +``` + + +## 3. How to purge and clean opensds cluster + +### Run opensds-ansible playbook to clean the environment +```bash +sudo ansible-playbook clean.yml -i local.hosts +``` + +### Run ceph-ansible playbook to clean ceph cluster if ceph is deployed +```bash +cd /opt/ceph-ansible +sudo ansible-playbook infrastructure-playbooks/purge-cluster.yml -i ceph.hosts +``` + +In addition, clean up the logical partition on the physical block device used by ceph, using the ```fdisk``` tool. + +### Remove ceph-ansible source code (optional) +```bash +cd .. +sudo rm -rf /opt/ceph-ansible +```