Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(kubernetes): kubernetes helm chart install documentation #4084

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
188 changes: 188 additions & 0 deletions docs/install/options/kubernetes.mdx
@@ -0,0 +1,188 @@
---
title: 'Kuberentes'
description: 'Helmchart deployment'
---

<Tip>
Set up Activepieces using helmcharts for easy deployment The helmchart is
configurable enough to allow for personal, testing and production (corporate)
installs We suggest using PostgreSQL and Redis value configurations for
production deployments.
</Tip>

To get up and running quickly with Activepieces, we will use the Activepieces helmchart. Follow these steps:

## Prerequisites

You need to have your Kubernetes cluster running, configured to be accessible from the machine you are running this from. You will also need Helm installed on your machine in order to set up Activepieces via Helmchart.

## Install

### Add the helmchart repository

Add the helmchart repository with the following command:

```bash
helm repo add meyercharts https://mariomeyer.github.io/repo
```

### Customize the values you want for your helm install

Copy the following default values to a local `values.yaml` file:

```yaml
# Default values for activepieces.
# This is a YAML-formatted file.
# Declare variables to be passed into your templates.

replicaCount: 1

image:
repository: docker.io/activepieces/activepieces
pullPolicy: IfNotPresent
# Overrides the image tag whose default is the chart appVersion.
tag: 'latest'

imagePullSecrets: []
nameOverride: ''
fullnameOverride: ''

serviceAccount:
# Specifies whether a service account should be created
create: true
# Automatically mount a ServiceAccount's API credentials?
automount: true
# Annotations to add to the service account
annotations: {}
# The name of the service account to use.
# If not set and create is true, a name is generated using the fullname template
name: ''

podAnnotations: {}
podLabels: {}

podSecurityContext:
{}
# fsGroup: 2000

securityContext:
{}
# capabilities:
# drop:
# - ALL
# readOnlyRootFilesystem: true
# runAsNonRoot: true
# runAsUser: 1000

service:
type: ClusterIP
port: 80
host:

queue:
#mode: MEMORY
mode: REDIS
url:
ui:
enabled: true
username:
password:

# ngrok credentials
ngrok:
domain:

db:
type: POSTGRES
host: <host>
port: 5432
username: <username>
password: <password>
database: <database>
ssl:
# enabled: true
# certificate:|
# -----BEGIN CERTIFICATE-----
# ...
# -----END CERTIFICATE-----

ingress:
enabled: true
className: 'nginx'
annotations:
{}
# kubernetes.io/ingress.class: nginx
# kubernetes.io/tls-acme: "true"
hosts:
# - host:
# paths:
# - path: /
# pathType: Prefix
tls: []
# - secretName: chart-example-tls
# hosts:
# - chart-example.local

resources:
{}
# We usually recommend not to specify default resources and to leave this as a conscious
# choice for the user. This also increases chances charts run on environments with little
# resources, such as Minikube. If you do want to specify resources, uncomment the following
# lines, adjust them as necessary, and remove the curly braces after 'resources:'.
# limits:
# cpu: 100m
# memory: 128Mi
# requests:
# cpu: 100m
# memory: 128Mi

autoscaling:
enabled: false
minReplicas: 1
maxReplicas: 100
targetCPUUtilizationPercentage: 80
# targetMemoryUtilizationPercentage: 80

# Additional volumes on the output Deployment definition.
volumes: []
# - name: foo
# secret:
# secretName: mysecret
# optional: false

# Additional volumeMounts on the output Deployment definition.
volumeMounts: []
# - name: foo
# mountPath: "/etc/foo"
# readOnly: true

nodeSelector: {}

tolerations: []

affinity: {}
```

### Apply the chart

Run the following command to apply the chart in your Kuberentes cluster:

```bash
helm install -f values.yaml activepieces meyercharts/activepieces
```

## Upgrade

Please follow the steps below:

### Reconfigure values.yaml

Do any changes on your `values.yaml` file with the desired configuration changes. You can also change the tag from `latest` to any version you'd like to upgrade to.

### Upgrade

```bash
helm upgrade -f values.yaml activepieces meyercharts/activepieces -n default
```

Congratulations! You have successfully upgraded your Activepieces helm deployment
6 changes: 5 additions & 1 deletion docs/install/options/overview.mdx
Expand Up @@ -11,7 +11,7 @@ Community Edition is **free** and **open source**.
You can read the difference between the editions [here](../../about/editions).
</Tip>

## Recommended Options
## Recommended Options

<CardGroup cols={2}>
<Card title="Docker (Fastest)" icon="docker" color="#248fe0" href="./docker">
Expand All @@ -22,6 +22,10 @@ Deploy Activepieces as a single Docker container using the SQLite database.
Deploy Activepieces with **Redis** and **PostgreSQL** setup.
</Card>

<Card title="Kubernetes Helm Chart" icon="layer-group" color="#00FFFF" href="./kuberentes">
Deploy Activepieces on **Kubernetes** cluster with your specific configuration via **Helm Charts**.
</Card>

</CardGroup>

## Other Options
Expand Down