Kuma Add-On Module

Kuma Add-On Module add-on module for the SIGHUP Distribution (SD) adds Kuma and Kong Mesh to your SD cluster.

If you are new to SD please refer to the official documentation on how to get started with SD.

Overview

Kuma Add-On Module add-on module deploys a service mesh into a Kubernetes cluster. A service mesh allows to transparently add capabilities like observability, traffic management, and security to applications, without modifying their source code. These capabilities are of great value when running microservices at scale or under strict security requirements.

Kuma

This module features Kuma Service Mesh. It's a modern control plane for microservices and service mesh for Kubernetes and VMs, with support for multiple meshes in one cluster.

Read more on Kuma docs.

Kong Mesh

Kong Mesh is an enterprise-grade service mesh built on top of Kuma.

Read more on Kong Mesh docs.

Packages

Kubernetes Fury Service Mesh provides the following packages:

Package	Version	Description
Kong Mesh	v2.7.2	Kong Mesh package. Includes standalone and multi-cluster setup.
Kuma	v2.7.2	Kuma package. Includes standalone and multi-cluster setup.

Compatibility

Kubernetes Version	Compatibility	Notes
1.25.x	✅	No known issues
1.26.x	✅	No known issues
1.27.x	✅	No known issues
1.28.x	✅	No known issues

Check the compatibility matrix for additional information about previous releases of the modules.

Usage

Prerequisites

Tool	Version	Description
furyctl	>=0.6.0	The recommended tool to download and manage SD modules and their packages. To learn more about furyctl read the official documentation.
kustomize	>=3.9.1	Packages are customized using kustomize. To learn how to create your customization layer with kustomize, please refer to the repository.
SD Monitoring Module	>=1.11.1	To have functioning metrics, dashboards and alerts.
SD Logging Module	>=1.7.1	When using tracing, ElasticSearch / OpenSearch is used as storage.
SD Ingress Module	>=2.0.0	To automate the handling of CA and certificates.

Kuma deployment

1. To start using Kuma Add-On Module, add to your Furyfile.yml the module as a base, you can also specify the single package:

bases:
    - name: kuma/kuma
      version: v1.1.0

See furyctl documentation for additional details about Furyfile.yml format.

2. Execute the following command to download the packages to your machine:

furyctl vendor -H

3. Inspect the downloaded packages under ./vendor/katalog/kuma to get familiar with the content.

4. Define a kustomization.yaml with that includes the ./vendor/katalog/kuma directory as a resource:

resources:
    - ./vendor/katalog/kuma/kuma/standalone

You can point to one of the predefined setups (standalone, multi-cluster/global-control-plane or multi-cluster/zone-control-plane) here. For additional details follow the examples.

Kong Mesh deployment

1. To start using Kubernetes Fury Service Mesh, add to your Furyfile.yml the module as a base, you can also specify the single package:

bases:
    - name: kuma/kong-mesh
      version: v1.1.0

See furyctl documentation for additional details about Furyfile.yml format.

2. Execute the following command to download the packages to your machine:

furyctl vendor -H

3. Inspect the downloaded packages under ./vendor/katalog/kuma to get familiar with the content.

4. Define a kustomization.yaml with that includes the ./vendor/katalog/kuma directory as a resource:

resources:
    - ./vendor/katalog/kuma/kong-mesh/standalone

You can point to one of the predefined setups (standalone, multi-cluster/global-control-plane or multi-cluster/zone-control-plane) here. For additional details follow the examples. :warning: You will need a valid license to use Kong Mesh. If you don't have it, please use Kuma instead.

Contributing

Before contributing, please read first the Contributing Guidelines.

Reporting Issues

In case you experience any problems with the module, please open a new issue.

Kong Mesh docs

Refer to ./docs/kong-mesh/README.md

License

This module is open-source and it's released under the following LICENSE