From 4f5263a38a88331930c2d61a791bfcf2db21fa92 Mon Sep 17 00:00:00 2001 From: andre-ebert-sva Date: Fri, 24 May 2024 10:25:35 +0200 Subject: [PATCH] reworked for 2024 --- README.md | 63 +++++++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 50 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 368620e..19e2d31 100644 --- a/README.md +++ b/README.md @@ -3,28 +3,41 @@ stuttgart-things/create-send-webhook configure and send customized webhooks to targets like MS TEAMS (supports connector cards). -install this role ------------------ +
ROLE INSTALLATION -copy the following and paste it on your ansible host to install the roles: -``` +installs role and all of it's dependencies w/: + +```bash cat < /tmp/requirements.yaml roles: - src: https://github.com/stuttgart-things/create-send-webhook.git scm: git collections: - name: community.general - version: 1.2.0 + version: 8.6.0 EOF + ansible-galaxy install -r /tmp/requirements.yaml --force ansible-galaxy collection install -r /tmp/requirements.yaml -f rm -rf /tmp/requirements.yaml ``` -Example Playbook ----------------- +
+ +
EXAMPLE INVENTORY +```bash +cat < inventory +[appserver] +1.2.3.4 ansible_user=sthings +EOF ``` + +
+ +
EXAMPLE PLAYBOOK - BASIC DOCKER AND DOCKER COMPOSE INSTALLATION + +```yaml --- - hosts: "{{ target_host | default('localhost') }}" @@ -43,25 +56,49 @@ Example Playbook - create-send-webhook ``` -Playbook execution (example) ------------------------------ +
-``` +
EXAMPLE EXECUTION + +```bash ansible-playbook create-send-webhook.yaml -vv ``` +
+ + +## License +
LICENSE + +Copyright 2020 patrick hermann. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +
+ Role history ---------------- | date | who | changelog | |---|---|---| +|2024-24-05 | Andre Ebert | incremented webhook version, removed tasks with missing config |2020-11-02 | Christian Müller | intial commit for this role in codehub / initialy needed for rancher-things automation -License -------- -BSD Author Information ------------------ +```yaml +Andre Ebert (andre.ebert@sva.de), 05/2024 + Christian Müller (christian.mueller@sva.de), SVA GmbH, 11/2020 +```