tree: 0d4b8d18e4bc4c6bc64e9ed7e86a81b332496994 [path history] [tgz]
  1. .gitignore
  2. .gitreview
  3. LICENSE.txt
  4. README.md
  5. ansible.cfg
  6. bootstrap-dev-env.yml
  7. collect-diag-playbook.yml
  8. compute-node-enable-playbook.yml
  9. compute-node-refresh-playbook.yml
  10. copy-cord-playbook.yml
  11. copy-profile-playbook.yml
  12. cord-automation-playbook.yml
  13. cord-config-playbook.yml
  14. cord-fabric-pingtest.yml
  15. cord-refresh-fabric.yml
  16. credentials/
  17. deploy-computenode-playbook.yml
  18. deploy-elasticstack-playbook.yml
  19. deploy-mavenrepo-playbook.yml
  20. deploy-onos-playbook.yml
  21. deploy-openstack-playbook.yml
  22. devel-tools-playbook.yml
  23. docs/
  24. filter_plugins/
  25. glance-images-playbook.yml
  26. install-kubernetes-tools-playbook.yml
  27. inventory/
  28. library/
  29. onboard-exampleservice-playbook.yml
  30. onboard-openstack-playbook.yml
  31. onboard-profile-playbook.yml
  32. onos-debug-playbook.yml
  33. pod-test-playbook.yml
  34. prep-buildnode-playbook.yml
  35. prep-computenode-playbook.yml
  36. prep-headnode-playbook.yml
  37. prereqs-check-playbook.yml
  38. publish-images-playbook.yml
  39. roles/
  40. scripts/
  41. ssh_pki/
  42. start-xos-helm-playbook.yml
  43. start-xos-playbook.yml
  44. teardown-onos-playbook.yml
  45. teardown-openstack-playbook.yml
  46. teardown-xos-playbook.yml
  47. vtn-refresh-playbook.yml
  48. xos-api-test-playbook.yml
  49. xos-service-config.yml
  50. xos-services-up.yml
README.md

CORD platform-install

This repository contains Ansible playbooks for installing and configuring software components that build a CORD POD: OpenStack, ONOS, and XOS.

It is used as a sub-module of the main CORD repository.

Credentials

Credentials will be autogenerated and placed in the credentials/ directory when the playbooks are run, where the credential name is the filename, and the contents of the file is the password.

For most profiles the XOS admin user is named xosadmin@opencord.org.

Creating a new CORD profile

To create a new CORD profile, you should create a .yaml variables file in profile_manifests/ with the name of your profile (ex: my-profile.yaml), and populate it with your configuration.

Making changes and lint checking your changes

Before commit, please run ./scripts/lintcheck.sh . in the repo root, which will perform the same ansible-lint check that Jenkins performs when in review in gerrit.

Specific profiles notes

opencloud

Used as a part of the OpenCloud deployment. Similar to rcord.

rcord

This is a part of the R-CORD deployment - start using the steps specified in that repo.

This profile is designed to integrate XOS with physical infrastructure pieces like MaaS, OpenStack, and ONOS. See the CORD-in-a-Box Quick Start Guide for how to set up a virtual multi-node R-CORD pod on a single host.

ecord

E-CORD description goes here.

mcord

M-CORD description goes here.

Design Notes for Developers

Variables used in platform-install

cord_profile: name of the profile_manifest to use.

Paths on configuration node (where playbooks are run, may also be build node)

  • config_cord_dir location on configuration node of cord dir
  • config_cord_profile_dir location on configuration node of cord_profile dir
  • pki_dir, ssh_pki_dir: where SSL and SSH certificates are created on config node
  • credentials_dir - location where autogenerated passwords file are created

Paths on head node (target system operated on by playbooks)

  • head_cord_dir - where the cord directory is copied to on the head node (deprecated when we reach container-only deploys)
  • head_cord_profile_dir - location of the cord_profile directory on the head node
  • head_onos_cord_dir - location of the onos-cord directory on the head node
  • head_onos_fabric_dir - location of the onos-fabric directory on the head node

Style notes

Prefix every role file with the yaml start block and comment with name of file relative to role base.

---
# rolename/tasks/main.yml

When using templates, put the template filename and path within the role as a comment in the template so that it's easy to determine which template was used to create a file after it's been created.

If you use a variable that isn't created by the ansible setup task, define it in the role defaults file. The default value for anay variable must be the same across all role defaults.

Use the YAML style syntax for tasks, not the older = syntax, as the former is more likely to indent and syntax highlight properly in most editors.

Roles should always have the same outcome, so avoid using conditionals or tags to change the behavior of a role. These features should only be used for avoiding time-consuming tasks in an idempotent manner.