opendev/system-config
Code Issues Proposed changes

Update docs with correct information about github apps

Browse Source 
The previous information about what setting goes where was just flat
wrong. Fix it.

Change-Id: I56ef1c90ddf24a46566370bb86d602b9d4e79557
This commit is contained in:
Monty Taylor 2017-07-27 14:46:25 -05:00
parent e493123639
commit a05340faa5
No known key found for this signature in database
GPG Key ID: 7BAE94BC7141A594
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/source/github.rst
View File

@ -63,12 +63,16 @@ App can be found in the :ref:`zuul` page at :ref:`zuul_github_projects`.
The OpenStack Zuul App is managed `OpenStack Zuul Settings Page`_ which is
available to admins of the `openstack-infra Organization`_.
The OpenStack Zuul App has a Private key, a Webhook secret and a set of OAuth
Credentials which are all stored in hiera.
The OpenStack Zuul App has an ID, a Private key, a Webhook secret and a set of
OAuth Credentials which are all stored in hiera.
The ID is a numerical identifier found on the App settings page labeled **ID**.
The ID is placed into the ``app_id`` field in the ``github``
entry in ``zuul_connection_secrets`` for the ``zuulv3.openstack.org`` FQDN.
The Private key can only be retrieved when it is generated, so in the case it
is lost a new one must be generated and the resulting value put into hiera.
The Private key is placed into the ``api_token`` field in the ``github``
The Private key is placed into the ``app_key`` field in the ``github``
entry in ``zuul_connection_secrets`` for the ``zuulv3.openstack.org`` FQDN.
GitHub sends JSON payloads via HTTP POST to the URL configured in the Webhook