System configuration for the OpenDev Collaboratory
Go to file
Clark Boylan 07c7f757d0 Add comments to manage-projects about project-config syncing
There were questions around project-config syncing and the way it is
done in manage-projects during our last project renaming. I've since
read through teh code to try and understand things better and have added
comments to manage-projects.yaml indicating the risks here and why we
approach it the way we do. There is no functional change only an attempt
at better understanding for the future.

Change-Id: I60aa58a36108edce3e00ecf2ac10be3dee7e8ea0
2021-10-21 11:44:02 -07:00
assets gitea: cleanup logo assets 2021-09-17 12:35:07 +10:00
doc Rename Gerrit Non-Interactive Users to Service Users 2021-10-11 08:53:59 -07:00
docker Build Gerrit 3.3.7 images 2021-10-14 11:46:44 -07:00
hiera Stop managing OpenStackID servers 2021-08-31 19:53:13 +00:00
inventory Switch test gerrit hostname to review99.opendev.org 2021-10-12 09:48:53 -07:00
kubernetes Update opendev git references in puppet modules 2019-04-20 18:26:07 +00:00
launch Fix min swap value in make_swap.sh 2021-05-14 14:09:11 -07:00
manifests Stop managing OpenStackID servers 2021-08-31 19:53:13 +00:00
modules/openstack_project Stop managing OpenStackID servers 2021-08-31 19:53:13 +00:00
playbooks Add comments to manage-projects about project-config syncing 2021-10-21 11:44:02 -07:00
roles openafs-client: add service timeout override 2021-06-16 11:50:53 +10:00
roles-test system-config-roles: only match jobs on roles tested 2021-05-07 11:05:21 +10:00
testinfra Merge "More yaml.safe_load() in testinfra/conftest.py" 2021-10-13 23:46:14 +00:00
tools Add matrix-eavesdrop container image 2021-07-23 14:28:22 -07:00
zuul.d Build Gerrit 3.3.7 images 2021-10-14 11:46:44 -07:00
.gitignore Ignore ansible .retry files 2016-07-15 12:04:48 -07:00
.gitreview OpenDev Migration Patch 2019-04-19 19:26:05 +00:00
bindep.txt Add libffi dev packages needed for ansible install 2016-10-04 15:20:00 -07:00
COPYING.GPL Add yamlgroup inventory plugin 2018-11-02 08:19:53 +11:00
Gemfile Update some paths for opendev 2019-04-20 09:31:14 -07:00
install_modules.sh Merge "Better checking for tags when cloning puppet modules" 2020-01-16 23:01:33 +00:00
install_puppet.sh Install the puppetlabs puppet package 2018-08-23 14:55:08 +10:00
modules.env Stop managing OpenStackID servers 2021-08-31 19:53:13 +00:00
Rakefile Further changes to bring puppetboard online 2014-03-22 12:54:38 -07:00
README.rst Cleanup eavesdrop puppet references 2021-06-10 09:02:23 +10:00
run_k8s_ansible.sh Invoke run_k8s_ansible from its directory 2019-05-07 16:03:59 -07:00
run_puppet.sh Clean up bashate failures 2014-09-30 12:40:59 -07:00
setup.cfg Mention new mailing lists 2020-04-06 18:19:28 +00:00
setup.py Update to openstackdocstheme 2018-06-25 11:19:43 +10:00
tox.ini Stop redirecting for the paste site 2021-08-19 15:21:03 +10:00

OpenDev System Configuration

This is the machinery that drives the configuration, testing, continuous integration and deployment of services provided by the OpenDev project.

Services are driven by Ansible playbooks and associated roles stored here. If you are interested in the configuration of a particular service, starting at playbooks/service-<name>.yaml will show you how it is configured.

Most services are deployed via containers; many of them are built or customised in this repository; see docker/.

A small number of legacy services are still configured with Puppet. Although the act of running puppet on these hosts is managed by Ansible, the actual core of their orchestration lives in manifests and modules.

Testing

OpenDev infrastructure runs a complete testing and continuous-integration environment, powered by Zuul.

Any changes to playbooks, roles or containers will trigger jobs to thoroughly test those changes.

Tests run the orchestration for the modified services on test nodes assigned to the job. After the testing deployment is configured (validating the basic environment at least starts running), specific tests are configured in the testinfra directory to validate functionality.

Continuous Deployment

Once changes are reviewed and committed, they will be applied automatically to the production hosts. This is done by Zuul jobs running in the deploy pipeline. At any one time, you may see these jobs running live on the status page or you could check historical runs on the pipeline results (note there is also an opendev-prod-hourly pipeline, which ensures things like upstream package updates or certificate renewals are incorporated in a timely fashion).

Contributing

Contributions are welcome!

You do not need any special permissions to make contributions, even those that will affect production services. Your changes will be automatically tested, reviewed by humans and, once accepted, deployed automatically.

Bug fixes or modifications to existing code are great places to start, and you will see the results of your changes in CI testing.

You can develop all the playbooks, roles, containers and testing required for a new service just by uploading a change. Using a similar service as a template is generally a good place to start. If deploying to production will require new compute resources (servers, volumes, etc.) these will have to be deployed by an OpenDev administrator before your code is committed. Thus if you know you will need new resources, it is best to coordinate this before review.

The #opendev IRC on OFTC channel is the main place for interactive discussion. Feel free to ask any questions and someone will try to help ASAP. The OpenDev meeting is a co-ordinated time to synchronize on infrastructure issues. Issues should be added to the agenda for discussion; even if you can not attend, you can raise your issue and check back on the logs later. There is also the service-discuss mailing list where you are welcome to send queries or questions.

Documentation

The latest documentation is available at https://docs.opendev.org/opendev/system-config/latest/

That documentation is generated from this repository. You can geneate it yourself with tox -e docs.