safe-stack

Safe-Stack

Warning

Disclaimer: This repository is currently a work in progress. While contributions and feedback are welcome, please note that the code and features may change frequently, and some functionalities may not be fully implemented or tested. Use this project at your own risk.

Introduction

This chart bootstraps a safe infrastructure deployment on a Kubernetes cluster using the Helm package manager.

We also package the following helm charts from Bitnami for you to optionally use:

Chart	Descrption
PostgreSQL	For use as a database
Redis	For enabling caching
RabbitMQ	For use as a message broker

Prerequisites

• Kubernetes 1.19+
• Persistent Volume provisioner support in the underlying infrastructure
• Helm 3+. Please refer to Helm's documentation to get started.
• Ethereum Node JSON-RPC Endpoint
• PostgreSQL v14 (optional)
• Redis (optional)
• RabbitMQ (optional)

Installing the Chart

To install the chart with the release name [RELEASE-NAME]:

helm repo add safe https://5afe.github.io/safe-helm-charts/charts/packages

helm install [RELEASE-NAME] safe/safe-stack

The command deploys safe-stack on the Kubernetes cluster in the default configuration. The configuration section lists the parameters that can be configured during installation.

Tip: List all releases using helm list

Uninstalling the Chart

To uninstall the [RELEASE-NAME] deployment:

helm uninstall [RELEASE-NAME]

The command removes all the Kubernetes components associated with the chart and deletes the release.

Upgrading Chart

To upgrade the [RELEASE-NAME] deployment with the latest version:

helm upgrade [RELEASE-NAME] safe/safe-stack

Configuration

The following table lists the configurable parameters of the safe-stack chart and their default values.

See Customizing the Chart Before Installing. To see all configurable options with detailed comments:

helm show values safe/safe-stack

Common parameters

Parameter	Description	Default
nameOverride	Provide a name in place of safe-transaction-service for app: labels	""
fullnameOverride	Provide a name to substitute for the full names of resources	""

safe-transaction-service parameters

Parameter	Description	Default
safe-transaction-service.enabled	Spin up safe-transaction-service	true

Refer to safe-global/safe-transaction-service for configuration.

safe-config-service parameters

Parameter	Description	Default
safe-config-service.enabled	Spin up safe-config-service	true

Refer to safe-global/safe-config-service for configuration.

safe-client-gateway parameters

Parameter	Description	Default
safe-client-gateway.enabled	Spin up safe-client-gateway	true

Refer to safe-global/safe-client-gateway for configuration.

safe-wallet-web parameters

Parameter	Description	Default
safe-wallet-web.enabled	Spin up safe-wallet-web	true

Refer to safe-global/safe-wallet-web for configuration.

Troubleshooting