C8 Self-Managed Checks

Overview

This project aims to perform a health check of a Kubernetes installation with Camunda Platform and Zeebe. It provides scripts for verifying connectivity and configuration within the Kubernetes cluster as well as with Zeebe components.

Directory Structure
Usage
- Kubernetes
- Zeebe Connectivity
License

The checks directory contains scripts for verifying Kubernetes and Zeebe connectivity and configuration. Each script can be executed independently.

Each script can be executed independently depending on the specific aspect you wish to test.

Usage

Kubernetes

Before using the Kubernetes health check scripts, ensure you have access to Kubernetes with a properly defined kube config context.

For more information on setting up kube config context, refer to the Kubernetes documentation.

Deployment Check (`/checks/kube/deployment.sh`)

Description:

This script checks the status of a Helm deployment in the specified namespace. It verifies the presence and readiness of required containers within the deployment, depending of your topology you may change required containers.

Usage:

Usage: ./checks/kube/deployment.sh [-h] [-n NAMESPACE] [-d HELM_DEPLOYMENT_NAME] [-l] [-c REQUIRED_CONTAINERS]
Options:
  -h                              Display this help message
  -n NAMESPACE                    Specify the namespace to use
  -d HELM_DEPLOYMENT_NAME         Specify the name of the helm deployment (default: camunda)
  -l                              Skip checks of the helm deployment (default: 0)
  -c REQUIRED_CONTAINERS          Specify the list of containers to check (comma-separated, default: console connector web-modeler optimize zeebe zeebe-gateway)

Example:

./checks/kube/deployment.sh -n camunda-primary -d camunda -c "zeebe,zeebe-gateway,web-modeler"

Dependencies:

kubectl: Required for interacting with Kubernetes clusters.

Connectivity Check (`/checks/kube/connectivity.sh`)

Description:

This script verifies Kubernetes connectivity and associated configuration. It checks for the presence of services and ingresses that conform to the required specifications.

Usage:

Usage: ./checks/kube/connectivity.sh [-h] [-n NAMESPACE] [-i]
Options:
  -h                              Display this help message
  -n NAMESPACE                    Specify the namespace to use
  -i                              Skip checks of the ingress class (default: 0)

Example:

./checks/kube/connectivity.sh -n camunda-primary

Dependencies:

kubectl: Required for interacting with Kubernetes clusters.
helm: Required for managing Helm deployments.

Zeebe Connectivity

Token generation check (`/checks/zeebe/token.sh`)

Description:

This script retrieves an access token from an authorization server using client credentials grant.

Usage:

Usage: ./checks/zeebe/token.sh [-h] [-a ZEEBE_AUTHORIZATION_SERVER_URL] [-i ZEEBE_CLIENT_ID] [-s ZEEBE_CLIENT_SECRET] [-u ZEEBE_TOKEN_AUDIENCE]
Options:
  -h                                  Display this help message
  -a ZEEBE_AUTHORIZATION_SERVER_URL   Specify the authorization server URL (e.g.: https://local.distro.ultrawombat.com/auth/realms/camunda-platform/protocol/openid-connect/token)
  -i ZEEBE_CLIENT_ID                  Specify the client ID
  -s ZEEBE_CLIENT_SECRET              Specify the client secret
  -u ZEEBE_TOKEN_AUDIENCE             Specify the token audience
  -k                                  Skip TLS verification (insecure mode)
  -r CACERT                           Specify the path to CA certificate file
  -j CLIENTCERT                       Specify the path to client certificate file

Example:

./checks/zeebe/token.sh -a https://local.distro.example.com/auth/realms/camunda-platform/protocol/openid-connect/token -i myclientid -s 0Rn28VrQxGNxowrCWe6wbujwFghO4990 -u zeebe.distro.example.com

Dependencies:

curl: Required for making HTTP requests.
A registred [1] application on C8 Identity

gRPC zeebe check (`/checks/zeebe/connectivity.sh`)

Description:

This script verifies connectivity to a Zeebe instance using HTTP/2 and gRPC protocols. It also checks the status using zbctl.

Usage:

Usage: ./checks/zeebe/connectivity.sh [-h] [-H ZEEBE_HOST]
Options:
  -h                                    Display this help message
  -H ZEEBE_HOST                         Specify the Zeebe host with the port (e.g., zeebe.c8.camunda.example.com:443)
  -p ZEEBE_VERSION                      Specify the Zeebe version (default is latest version: 8.x.x)
  -f PROTO_FILE                         Specify the path to gateway.proto file or leave empty to download it (default behavior is to download the protofile)
  -k                                    Skip TLS verification (insecure mode)
  -r CACERT                             Specify the path to CA certificate file
  -j CLIENTCERT                         Specify the path to Client certificate file
  -a ZEEBE_AUTHORIZATION_SERVER_URL     Specify the authorization server URL (e.g.: https://local.distro.example.com/auth/realms/camunda-platform/protocol/openid-connect/token)
  -i ZEEBE_CLIENT_ID                    Specify the client ID
  -s ZEEBE_CLIENT_SECRET                Specify the client secret
  -u ZEEBE_TOKEN_AUDIENCE               Specify the token audience

Example:

./checks/zeebe/connectivity.sh -a https://local.distro.example.com/auth/realms/camunda-platform/protocol/openid-connect/token -i myclientid -s 0Rn28VrQxGNxowrCWe6wbujwFghO4990 -u zeebe.distro.example.com -H zeebe.local.distro.example.com:443

Dependencies:

curl: Required for making HTTP requests.
grpcurl: Required for testing gRPC connectivity.
zbctl: Required for checking Zeebe status.
A registred [1] application on C8 Identity

Reference

[1] C8: How to register your application on Identity.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Awaiting Schedule

These updates are awaiting their schedule. Click on a checkbox to get an update now.

chore(deps): update actions/checkout digest to a5ac7e5
chore(deps): update pre-commit hook renovatebot/pre-commit-hooks to v37.374.3
chore(deps): update actions/cache action to v4
chore(deps): update peter-evans/create-issue-from-file action to v5

Detected dependencies

asdf

.tool-versions

pre-commit 3.7.1

github-actions

.github/workflows/links.yml

actions/checkout v4@0ad4b8fadaa221de15dcec353f45205ec38ea70b

actions/cache v3@e12d46a63a90f2fae62d114769bbf2a179198b5c

lycheeverse/lychee-action v1.10.0@2b973e86fc7b1f6b36a93795fe2c9c6ae1118621

peter-evans/create-issue-from-file v4@433e51abf769039ee20ba1293a088ca19d573b7f

.github/workflows/lint.yml

actions/checkout v4@0ad4b8fadaa221de15dcec353f45205ec38ea70b

pre-commit/action v3.0.1@2c7b3805fd2a0fd8c1884dcaebf91fc102a13ecd

pre-commit

.pre-commit-config.yaml

pre-commit/pre-commit-hooks v4.6.0

rhysd/actionlint v1.7.0

renovatebot/pre-commit-hooks 37.368.9

compilerla/conventional-pre-commit v3.2.0

shellcheck-py/shellcheck-py v0.10.0.1

regex

checks/zeebe/connectivity.sh

camunda/zeebe 8.5.1

Check this box to trigger a request for Renovate to run again on this repository

camunda / c8-sm-checks Goto Github PK

c8-sm-checks's Introduction

C8 Self-Managed Checks

Overview

Table of Contents

Usage

Kubernetes

Deployment Check (/checks/kube/deployment.sh)

Description:

Usage:

Example:

Dependencies:

Connectivity Check (/checks/kube/connectivity.sh)

Description:

Usage:

Example:

Dependencies:

Zeebe Connectivity

Token generation check (/checks/zeebe/token.sh)

Description:

Usage:

Example:

Dependencies:

gRPC zeebe check (/checks/zeebe/connectivity.sh)

Description:

Usage:

Example:

Dependencies:

Reference

License

c8-sm-checks's People

Contributors

Watchers

c8-sm-checks's Issues

Awaiting Schedule

Detected dependencies

Recommend Projects

Recommend Topics

Recommend Org

Deployment Check (`/checks/kube/deployment.sh`)

Connectivity Check (`/checks/kube/connectivity.sh`)

Token generation check (`/checks/zeebe/token.sh`)

gRPC zeebe check (`/checks/zeebe/connectivity.sh`)