scottk/siembol
1
0
Fork 0
mirror of https://github.com/optim-enterprises-bv/siembol.git synced 2025-11-01 19:07:59 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
ci-fetch-all-artifacts
siembol/docs/deployment/how-tos/how_to_setup_github_webhook.md
Marian Novotny 2950501eff doc: improved documentation (#248) 
* Some sample changes

* A first pass of the deployment how-to's

Co-authored-by: stackedsax <alex.scammon@gresearch.co.uk>
2021-04-22 09:34:00 +01:00

2.1 KiB
Raw Permalink Blame History

How to set-up a GitHub webhook

The synchronisation of service configurations are stored in git repositories with Zookeeper nodes is implemented in siembol in config editor rest service.

Siembol config editor rest rest endpoint for webhooks

Find a hostname of siembol config editor rest and prepare URL.

URL parameters

  • serviceNames: Comma-separated list of service names or all if the hook is for all services
  • syncType: Type of synchronisation that should be triggered by the hook. One of:
    • ALL
    • RELEASE
    • ADMIN_CONFIG

Example URL:

Setting a webhook in a GitHub repository

For a git repository you should recognise:

  • services which configurations are stored in a git repository
  • type of configurations that are stored in the git repository

Prepare and test URL

You can prepare a URL using the above example or by using Swagger.

Example Swagger URL:

Ensure that the prepared URL is accessible form the GitHub server.

Set a webhook URL in GitHub

To set up a webhook:

  • Go to the settings page of your repository or organization in GitHub
  • Click Webhooks
  • Click Add Webhook
  • Add a Payload URL
  • Select 'Just the push event.'
  • Click Add webhook

Set the content type

Set the content type as application/json

Set the GitHub secret (optional)

Setting a webhook secret allows you to ensure that POST requests sent to siembol are from GitHub.

Set the secret for verification in config editor rest's application.properties file

The verification of webhook signature is computed only if is set the secret in the application properties of config editor rest. Otherwise this check is skipped.

config-editor.gitWebhookSecret=your_secret_provided_in_GitHub