425b091a1e
This job is to trigger readthedocs via their new API The old API was quite simple in that anyone could hit the end-point and trigger a new build. The v2 API now requires authentication and a unique id for each project we wish to update. If projects wish, they can directly use the new "trigger-readthedocs" role (from the dependent change) and create their own jobs, providing their username/password or webhook authentication token directly from a secret in their project playbook. This job, however, uses the infra secret for the "openstackci" user to update the docs. Projects that wish to take this route require some minor setup, but don't have to worry about managing new jobs or their secrets and gain some benefits in having the openstackci user as a backup admin. To use the trigger-readthedocs-webhook job, projects will need to do the following: 1) add openstackci user as an admin of their RTD project 2) generate an webhook via the "Integrations" dashboard page on the RTD project 3) provide the id from that webhook URL in job or project variables. This webhook id is not private; it is useless without authentication (it appears to be a global monotonically increasing integer for each webhook generated). 4) include the job. gerrit-dash-creator is populated with the new job for initial testing. Other projects are currently using the "docs-on-readthedocs" template. Change I3b65813671961d07c0a743685c537ad1df4bf68 proposes switching the template to use this new job. Change-Id: Ic34ea5ead26a477a1cc5f8b25fd2ce1949c1dc13 Depends-On: https://review.openstack.org/579434 Depends-On: https://review.openstack.org/584230 |
||
|---|---|---|
| accessbot | ||
| dev/gerrit | ||
| docs-site | ||
| gerrit | ||
| gerritbot | ||
| grafana | ||
| nodepool | ||
| playbooks | ||
| roles | ||
| specs | ||
| tests | ||
| tools | ||
| zuul | ||
| zuul.d | ||
| .gitignore | ||
| .gitreview | ||
| bindep.txt | ||
| CONTRIBUTING.rst | ||
| LICENSE | ||
| README.rst | ||
| REVIEWING.rst | ||
| test-requirements.txt | ||
| tox.ini | ||
OpenStack Infra Config Files
This repo contains a set of config files that are consumed by the openstack-infra/system-config puppet modules in order to deploy and configure the OpenStack Infrastructure. You should edit these files to make configuration changes to the OpenStack Infrastructure.
accessbot
This dir contains the IRC access bot channel config. This config file is used to specify which channels are managed by the infra team and the permissions assigned to nicks in those channels.
gerrit
This dir contains the main project registry in projects.yaml along with all of the gerrit project ACLs in the acls subdir. You will need to edit these files to add new projects to Gerrit.
See the Creator's Guide in the Infra Manual for info on adding projects.
gerritbot
This dir contains the gerritbot channel config file. Edit this file to add the gerritbot to your IRC channels for gerrit event messages.
grafana
This dir contains dashboards to display at http://grafana.openstack.org/. Add new files to create additional dashboards or edit the existing ones to enhance the dashboards.
nodepool
This dir contains the nodepool scripts and nodepool disk image builder elements that are used to build the images we boot build nodes off of. Edit these files if you need to modify the base images that Nodepool creates for Zuul to run content on.
specs
This dir contains the index.html file for the http://specs.openstack.org site. Edit this file if you are adding and removing projects from that site.
Static Web Hosting Documentation
zuul
This dir contains the zuul main.yaml file which defines the Zuul tenants and the system-variables.yaml file which contains some global variables. Edit these files to add, remove or rename a project from Zuul.
dev
This dir contains config files for the development deployments of the above services.