Nasqueron Agora - User contributions [en]

Operations grimoire/Notifications center

2016-08-24T01:03:56Z

2001:470:1F13:D91:F980:7449:6E00:B7F8: /* Upgrade a live container */

The notifications centers is an HTTP to HTTP and HTTP to AMQP gateway for our CI infrastructure.

It allows to receive events from GitHub, Docker Hub and Phabricator, and send them to a RabbitMQ broker (white-rabbit) or Phabricator.

== Requirements ==
* [[Operations grimoire/Docker engine|Docker engine]]
* [[Operations grimoire/RabbitMQ|RabbitMQ broker]]

== Run it ==
=== Start a new container ===
<code>run-notifications</code>

=== Upgrade a live container ===
# Enter notifications container as app user : <code>docker exec -it --user=app notifications bash</code>
# Check we're on the master branch and the history is clean
# Update code rebasing the production branch against origin/master
# If composer has been touched, <code>composer update</code> (could be faster to docker pull, stop this container and start a new container)
# If entered as root, fix ownership with <code>chown -R app:app /var/wwwroot/default</code>
# Restart PHP FPM with <code>sv restart php-fpm</code>
# Run <code>php optimize</code> to refresh compiled class
# Restart again PHP FPM with <code>sv restart php-fpm</code>

For longer upgrade, you can put the application in maintenance mode with <code>php artisan down</code>.

If preferences are updated (in the code or by us), update the cache: <code>php artisan config:cache && sv restart php-fpm</code> is needed.

=== How to rebase against master? ===

# update master to match origin/master
# rebase production against master

<syntaxhighlight lang="console">
$ git fetch
$ git checkout master
$ git rebase origin/master
$ git checkout production
$ git rebase master
</syntaxhighlight>

If there is a merge conflict:

# Edit the conflict files
# <code>git add <edited files></code>
# <code>git rebase --continue</code>

== Configure it ==
=== Add a new GitHub organization ===
# Generate a random string to be used as a secret token shared between GitHub and the notifications center
# On Dwellers, add credentials to /data/notifications/storage/app/credentials.json
# On GitHub, go to organization settings, then Webhooks, e.g. https://github.com/organizations/acme/settings/hooks
# Add webhook:
## URL should be https://notifications.nasqueron.org/gate/GitHub/Acme where Acme is the ucfirst name of the organization account
## Your secret token go to secret field
## Switch from push events to "Send me everything".
## Let default settings: active, SSL verification, application/json
# Run the CLI client to receive notifications (`notifications` on Ysul, require to be in the `notifications` group, editable through /etc/group)
# GitHub will then fire immediately a ping, check in recent deliveries it's 200
# Fix and redeliver it if not
# Check in the CLI you've got a correct reply, e.g. [16:36:13] <Eglide/orgz> « Anything added dilutes everything else. » — GitHub Webhooks ping zen aphorism.

For payload delivery code returned by notifications.nasqueron.org, a 500 means probably a JSON syntax error in credentials.json, a 403 tokens don't match, note the center doesn't verify token if an empty string is left in the config (or you made a typo to the property).

== Links ==
# [https://devcentral.nasqueron.org/diffusion/NOTIF/ Source code]
# [https://devcentral.nasqueron.org/tag/notifications_center/ DevCentral board]

{{Configuration as Code}}
{{Vault secrets migration}}

Operations grimoire/Notifications center

2016-08-24T01:00:33Z

2001:470:1F13:D91:F980:7449:6E00:B7F8: /* Upgrade a live container */

The notifications centers is an HTTP to HTTP and HTTP to AMQP gateway for our CI infrastructure.

It allows to receive events from GitHub, Docker Hub and Phabricator, and send them to a RabbitMQ broker (white-rabbit) or Phabricator.

== Requirements ==
* [[Operations grimoire/Docker engine|Docker engine]]
* [[Operations grimoire/RabbitMQ|RabbitMQ broker]]

== Run it ==
=== Start a new container ===
<code>run-notifications</code>

=== Upgrade a live container ===
# Enter notifications container as app user : <code>docker exec -it --user=app notifications bash</code>
# Check we're on the master branch and the history is clean
# Update code rebasing the production branch against origin/master
# If composer has been touched, <code>composer update</code> (could be faster to docker pull, stop this container and start a new container)
# If entered as root, fix ownership with <code>chown -R app:app /var/wwwroot/default</code>
# Restart PHP FPM with <code>sv restart php-fpm</code>
# Run <code>php optimize</code> to refresh compiled class
# Restart again PHP FPM with <code>sv restart php-fpm</code>

For longer upgrade, you can put the application in maintenance mode with <code>php artisan down</code>.

If preferences are updated (in the code or by us), <code>php artisan config:clear</code> is needed.

=== How to rebase against master? ===

# update master to match origin/master
# rebase production against master

<syntaxhighlight lang="console">
$ git fetch
$ git checkout master
$ git rebase origin/master
$ git checkout production
$ git rebase master
</syntaxhighlight>

If there is a merge conflict:

# Edit the conflict files
# <code>git add <edited files></code>
# <code>git rebase --continue</code>

== Configure it ==
=== Add a new GitHub organization ===
# Generate a random string to be used as a secret token shared between GitHub and the notifications center
# On Dwellers, add credentials to /data/notifications/storage/app/credentials.json
# On GitHub, go to organization settings, then Webhooks, e.g. https://github.com/organizations/acme/settings/hooks
# Add webhook:
## URL should be https://notifications.nasqueron.org/gate/GitHub/Acme where Acme is the ucfirst name of the organization account
## Your secret token go to secret field
## Switch from push events to "Send me everything".
## Let default settings: active, SSL verification, application/json
# Run the CLI client to receive notifications (`notifications` on Ysul, require to be in the `notifications` group, editable through /etc/group)
# GitHub will then fire immediately a ping, check in recent deliveries it's 200
# Fix and redeliver it if not
# Check in the CLI you've got a correct reply, e.g. [16:36:13] <Eglide/orgz> « Anything added dilutes everything else. » — GitHub Webhooks ping zen aphorism.

For payload delivery code returned by notifications.nasqueron.org, a 500 means probably a JSON syntax error in credentials.json, a 403 tokens don't match, note the center doesn't verify token if an empty string is left in the config (or you made a typo to the property).

== Links ==
# [https://devcentral.nasqueron.org/diffusion/NOTIF/ Source code]
# [https://devcentral.nasqueron.org/tag/notifications_center/ DevCentral board]

{{Configuration as Code}}
{{Vault secrets migration}}

Operations grimoire/Notifications center

2016-08-23T19:53:30Z

2001:470:1F13:D91:F980:7449:6E00:B7F8: /* Upgrade a live container */

The notifications centers is an HTTP to HTTP and HTTP to AMQP gateway for our CI infrastructure.

It allows to receive events from GitHub, Docker Hub and Phabricator, and send them to a RabbitMQ broker (white-rabbit) or Phabricator.

== Requirements ==
* [[Operations grimoire/Docker engine|Docker engine]]
* [[Operations grimoire/RabbitMQ|RabbitMQ broker]]

== Run it ==
=== Start a new container ===
<code>run-notifications</code>

=== Upgrade a live container ===
# Enter notifications container as app user : <code>docker exec -it --user=app notifications bash</code>
# Check we're on the master branch and the history is clean
# Update code rebasing the production branch against origin/master
# If composer has been touched, <code>composer update</code> (could be faster to docker pull, stop this container and start a new container)
# If entered as root, fix ownership with <code>chown -R app:app /var/wwwroot/default</code>
# Restart PHP FPM with <code>sv restart php-fpm</code>
# Run <code>php optimize</code> to refresh compiled class
# Restart again PHP FPM with <code>sv restart php-fpm</code>

For longer upgrade, you can put the application in maintenance mode with <code>php artisan down</code>.

=== How to rebase against master? ===

# update master to match origin/master
# rebase production against master

<syntaxhighlight lang="console">
$ git fetch
$ git checkout master
$ git rebase origin/master
$ git checkout production
$ git rebase master
</syntaxhighlight>

If there is a merge conflict:

# Edit the conflict files
# <code>git add <edited files></code>
# <code>git rebase --continue</code>

== Configure it ==
=== Add a new GitHub organization ===
# Generate a random string to be used as a secret token shared between GitHub and the notifications center
# On Dwellers, add credentials to /data/notifications/storage/app/credentials.json
# On GitHub, go to organization settings, then Webhooks, e.g. https://github.com/organizations/acme/settings/hooks
# Add webhook:
## URL should be https://notifications.nasqueron.org/gate/GitHub/Acme where Acme is the ucfirst name of the organization account
## Your secret token go to secret field
## Switch from push events to "Send me everything".
## Let default settings: active, SSL verification, application/json
# Run the CLI client to receive notifications (`notifications` on Ysul, require to be in the `notifications` group, editable through /etc/group)
# GitHub will then fire immediately a ping, check in recent deliveries it's 200
# Fix and redeliver it if not
# Check in the CLI you've got a correct reply, e.g. [16:36:13] <Eglide/orgz> « Anything added dilutes everything else. » — GitHub Webhooks ping zen aphorism.

For payload delivery code returned by notifications.nasqueron.org, a 500 means probably a JSON syntax error in credentials.json, a 403 tokens don't match, note the center doesn't verify token if an empty string is left in the config (or you made a typo to the property).

== Links ==
# [https://devcentral.nasqueron.org/diffusion/NOTIF/ Source code]
# [https://devcentral.nasqueron.org/tag/notifications_center/ DevCentral board]

{{Configuration as Code}}
{{Vault secrets migration}}