Skip to content

Commit

Permalink
Merge pull request #28 from makeplane/develop
Browse files Browse the repository at this point in the history
Promoted Develop To Master
  • Loading branch information
mguptahub authored Aug 31, 2024
2 parents 101c3bf + 96c6a38 commit 581556b
Show file tree
Hide file tree
Showing 22 changed files with 127 additions and 9 deletions.
2 changes: 1 addition & 1 deletion charts/plane-ce/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Meet Plane. An open-source software development tool to manage issu

type: application

version: 1.0.21
version: 1.0.22
appVersion: "0.22.0"

home: https://plane.so
Expand Down
8 changes: 8 additions & 0 deletions charts/plane-ce/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@
| env.pgdb_name | plane | | Database name to be used while setting up stateful deployment of `Postgres`|
| env.pgdb_remote_url | | | Users can also decide to use the remote hosted database and link to Plane deployment. Ignoring all the above keys, set `postgres.local_setup` to `false` and set this key with remote connection url. |
| postgres.storageClass | longhorn | | Creating the persitant volumes for the stateful deployments needs the `storageClass` name. Set the correct value as per your kubernetes cluster configuration. |
| postgres.assign_cluster_ip | false | | Set it to `true` if you want to assign `ClusterIP` to the service |

### Redis Setup

Expand All @@ -97,6 +98,7 @@
| redis.volumeSize | 1Gi | | While setting up the stateful deployment, while creating the persistant volume, volume allocation size need to be provided. This key helps you set the volume allocation size. Unit of this value must be in Mi (megabyte) or Gi (gigabyte) |
| env.remote_redis_url | | | Users can also decide to use the remote hosted database and link to Plane deployment. Ignoring all the above keys, set `redis.local_setup` to `false` and set this key with remote connection url. |
| redis.storageClass | longhorn | | Creating the persitant volumes for the stateful deployments needs the `storageClass` name. Set the correct value as per your kubernetes cluster configuration. |
| redis.assign_cluster_ip | false | | Set it to `true` if you want to assign `ClusterIP` to the service |

### Doc Store (Minio/S3) Setup

Expand All @@ -114,6 +116,7 @@
| env.aws_region | | | External `S3` (or compatible) storage service providers creates any buckets in user selected region. This is also shared with the user as `region` for the application to connect and do the necessary upload/download operations. To be provided when `minio.local_setup=false` |
| env.aws_s3_endpoint_url | | | External `S3` (or compatible) storage service providers shares a `endpoint_url` for the integration purpose for the application to connect and do the necessary upload/download operations. To be provided when `minio.local_setup=false` |
| minio.storageClass | longhorn | | Creating the persitant volumes for the stateful deployments needs the `storageClass` name. Set the correct value as per your kubernetes cluster configuration. |
| minio.assign_cluster_ip | false | | Set it to `true` if you want to assign `ClusterIP` to the service |

### Web Deployment

Expand All @@ -123,6 +126,7 @@
| web.memoryLimit | 1000Mi | | Every deployment in kubernetes can be set to use maximum memory they are allowed to use. This key sets the memory limit for this deployment to use.|
| web.cpuLimit | 500m | | Every deployment in kubernetes can be set to use maximum cpu they are allowed to use. This key sets the cpu limit for this deployment to use.|
| web.image| makeplane/plane-frontend | | This deployment needs a preconfigured docker image to function. Docker image name is provided by the owner and must not be changed for this deployment |
| web.assign_cluster_ip | false | | Set it to `true` if you want to assign `ClusterIP` to the service |

### Space Deployment

Expand All @@ -132,6 +136,7 @@
| space.memoryLimit | 1000Mi | | Every deployment in kubernetes can be set to use maximum memory they are allowed to use. This key sets the memory limit for this deployment to use.|
| space.cpuLimit | 500m | | Every deployment in kubernetes can be set to use maximum cpu they are allowed to use. This key sets the cpu limit for this deployment to use.|
| space.image| makeplane/plane-space| | This deployment needs a preconfigured docker image to function. Docker image name is provided by the owner and must not be changed for this deployment |
| space.assign_cluster_ip | false | | Set it to `true` if you want to assign `ClusterIP` to the service |

### Admin Deployment

Expand All @@ -141,6 +146,7 @@
| admin.memoryLimit | 1000Mi | | Every deployment in kubernetes can be set to use maximum memory they are allowed to use. This key sets the memory limit for this deployment to use.|
| admin.cpuLimit | 500m | | Every deployment in kubernetes can be set to use maximum cpu they are allowed to use. This key sets the cpu limit for this deployment to use.|
| admin.image| makeplane/plane-admin | | This deployment needs a preconfigured docker image to function. Docker image name is provided by the owner and must not be changed for this deployment |
| admin.assign_cluster_ip | false | | Set it to `true` if you want to assign `ClusterIP` to the service |

### API Deployment

Expand All @@ -152,6 +158,7 @@
| api.image| makeplane/plane-backend | | This deployment needs a preconfigured docker image to function. Docker image name is provided by the owner and must not be changed for this deployment |
| env.sentry_dsn | | | (optional) API service deployment comes with some of the preconfigured integration. Sentry is one among those. Here user can set the Sentry provided DSN for this integration.|
| env.sentry_environment | | | (optional) API service deployment comes with some of the preconfigured integration. Sentry is one among those. Here user can set the Sentry environment name (as configured in Sentry) for this integration.|
| api.assign_cluster_ip | false | | Set it to `true` if you want to assign `ClusterIP` to the service |

### Worker Deployment

Expand Down Expand Up @@ -192,6 +199,7 @@
| Setting | Default | Required | Description |
|---|:---:|:---:|---|
| env.secret_key | 60gp0byfz2dvffa45cxl20p1scy9xbpf6d8c5y0geejgkyp1b5 | Yes | This must a random string which is used for hashing/encrypting the sensitive data within the application. Once set, changing this might impact the already hashed/encrypted data|
| env.default_cluster_domain | cluster.local | Yes | Set this value as configured in your kubernetes cluster. `cluster.local` is usally the default in most cases. |
## Custom Ingress Routes
Expand Down
31 changes: 31 additions & 0 deletions charts/plane-ce/questions.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,10 @@ questions:
label: "CPU Limit"
type: string
default: 500m
- variable: web.assign_cluster_ip
label: "Assign Cluster IP"
type: boolean
default: false


- variable: space.image
Expand Down Expand Up @@ -79,6 +83,10 @@ questions:
label: "CPU Limit"
type: string
default: 500m
- variable: space.assign_cluster_ip
label: "Assign Cluster IP"
type: boolean
default: false

- variable: admin.image
label: Admin Docker Image
Expand Down Expand Up @@ -107,6 +115,10 @@ questions:
label: "CPU Limit"
type: string
default: 500m
- variable: admin.assign_cluster_ip
label: "Assign Cluster IP"
type: boolean
default: true

- variable: api.image
label: Backend Docker Image
Expand Down Expand Up @@ -136,6 +148,10 @@ questions:
label: "CPU Limit"
type: string
default: 500m
- variable: api.assign_cluster_ip
label: "Assign Cluster IP"
type: boolean
default: false
- variable: env.cors_allowed_origins
label: "CORS Allowed Origins"
type: string
Expand Down Expand Up @@ -211,6 +227,11 @@ questions:
type: string
default: "1Gi"
show_if: "redis.local_setup=true"
- variable: redis.assign_cluster_ip
label: "Assign Cluster IP"
type: boolean
default: false
show_if: "redis.local_setup=true"
- variable: env.remote_redis_url
label: "Remote Redis URL"
type: string
Expand Down Expand Up @@ -263,6 +284,11 @@ questions:
type: string
default: "plane"
show_if: "postgres.local_setup=true"
- variable: postgres.assign_cluster_ip
label: "Assign Cluster IP"
type: boolean
default: false
show_if: "postgres.local_setup=true"
- variable: env.pgdb_remote_url
label: "Remote URL"
type: string
Expand Down Expand Up @@ -300,6 +326,11 @@ questions:
type: string
default: "5Gi"
show_if: "minio.local_setup=true"
- variable: minio.assign_cluster_ip
label: "Assign Cluster IP"
type: boolean
default: false
show_if: "minio.local_setup=true"
- variable: env.aws_access_key
label: "AWS Access Key"
type: string
Expand Down
2 changes: 2 additions & 0 deletions charts/plane-ce/templates/workloads/admin.deployment.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@ metadata:
labels:
app.name: {{ .Release.Namespace }}-{{ .Release.Name }}-admin
spec:
{{- if not .Values.admin.assign_cluster_ip }}
clusterIP: None
{{- end }}
ports:
- name: admin-3000
port: 3000
Expand Down
2 changes: 2 additions & 0 deletions charts/plane-ce/templates/workloads/api.deployment.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@ metadata:
labels:
app.name: {{ .Release.Namespace }}-{{ .Release.Name }}-api
spec:
{{- if not .Values.api.assign_cluster_ip }}
clusterIP: None
{{- end }}
ports:
- name: api-8000
port: 8000
Expand Down
2 changes: 2 additions & 0 deletions charts/plane-ce/templates/workloads/minio.stateful.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ metadata:
labels:
app.name: {{ .Release.Namespace }}-{{ .Release.Name }}-minio
spec:
{{- if not .Values.minio.assign_cluster_ip }}
clusterIP: None
{{- end }}
ports:
- name: minio-api-9000
port: 9000
Expand Down
2 changes: 2 additions & 0 deletions charts/plane-ce/templates/workloads/postgres.stateful.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ metadata:
labels:
app.name: {{ .Release.Namespace }}-{{ .Release.Name }}-pgdb
spec:
{{- if not .Values.postgres.assign_cluster_ip }}
clusterIP: None
{{- end }}
ports:
- name: pg-{{ .Values.postgres.servicePort }}
port: {{ .Values.postgres.servicePort }}
Expand Down
2 changes: 2 additions & 0 deletions charts/plane-ce/templates/workloads/redis.stateful.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ metadata:
labels:
app.name: {{ .Release.Namespace }}-{{ .Release.Name }}-redis
spec:
{{- if not .Values.redis.assign_cluster_ip }}
clusterIP: None
{{- end }}
ports:
- name: redis-{{ .Values.redis.servicePort }}
port: {{ .Values.redis.servicePort }}
Expand Down
2 changes: 2 additions & 0 deletions charts/plane-ce/templates/workloads/space.deployment.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@ metadata:
labels:
app.name: {{ .Release.Namespace }}-{{ .Release.Name }}-space
spec:
{{- if not .Values.space.assign_cluster_ip }}
clusterIP: None
{{- end }}
ports:
- name: space-3000
port: 3000
Expand Down
2 changes: 2 additions & 0 deletions charts/plane-ce/templates/workloads/web.deployment.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@ metadata:
labels:
app.name: {{ .Release.Namespace }}-{{ .Release.Name }}-web
spec:
{{- if not .Values.web.assign_cluster_ip }}
clusterIP: None
{{- end }}
ports:
- name: web-3000
port: 3000
Expand Down
7 changes: 7 additions & 0 deletions charts/plane-ce/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ redis:
storageClass: longhorn
volumeSize: 1Gi
pullPolicy: IfNotPresent
assign_cluster_ip: false

postgres:
local_setup: true
Expand All @@ -40,6 +41,7 @@ postgres:
storageClass: longhorn
volumeSize: 5Gi
pullPolicy: IfNotPresent
assign_cluster_ip: false

minio:
image: minio/minio:latest
Expand All @@ -49,34 +51,39 @@ minio:
root_user: admin
storageClass: longhorn
volumeSize: 5Gi
assign_cluster_ip: true

web:
replicas: 1
memoryLimit: 1000Mi
cpuLimit: 500m
image: makeplane/plane-frontend
pullPolicy: IfNotPresent
assign_cluster_ip: true

space:
replicas: 1
memoryLimit: 1000Mi
cpuLimit: 500m
image: makeplane/plane-space
pullPolicy: IfNotPresent
assign_cluster_ip: true

admin:
replicas: 1
memoryLimit: 1000Mi
cpuLimit: 500m
image: makeplane/plane-admin
pullPolicy: IfNotPresent
assign_cluster_ip: true

api:
replicas: 1
memoryLimit: 1000Mi
cpuLimit: 500m
image: makeplane/plane-backend
pullPolicy: IfNotPresent
assign_cluster_ip: false

worker:
replicas: 1
Expand Down
4 changes: 2 additions & 2 deletions charts/plane-enterprise/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ description: Meet Plane. An Enterprise software development tool to manage issue

type: application

version: 1.0.7
appVersion: "1.0.0"
version: 1.0.8
appVersion: "1.2.1"

home: https://plane.so/
icon: https://plane.so/favicon/favicon-32x32.png
Expand Down
7 changes: 7 additions & 0 deletions charts/plane-enterprise/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,7 @@
| env.pgdb_username | plane | | Database credentials are requried to access the hosted stateful deployment of `postgres`. Use this key to set the username for the stateful deployment. |
| env.pgdb_password | plane | | Database credentials are requried to access the hosted stateful deployment of `postgres`. Use this key to set the password for the stateful deployment. |
| env.pgdb_name | plane | | Database name to be used while setting up stateful deployment of `Postgres`|
| services.postgres.assign_cluster_ip | false | | Set it to `true` if you want to assign `ClusterIP` to the service |
| env.pgdb_remote_url | | | Users can also decide to use the remote hosted database and link to Plane deployment. Ignoring all the above keys, set `services.postgres.local_setup` to `false` and set this key with remote connection url. |

### Redis Setup
Expand All @@ -136,6 +137,7 @@
| services.redis.image | registry.plane.tools/plane/valkey:7.2.5-alpine | | Using this key, user must provide the docker image name to setup the stateful deployment of `redis`. (must be set when `services.redis.local_setup=true`)|
| services.redis.servicePort | 6379 | | This key sets the default port number to be used while setting up stateful deployment of `redis`. |
| services.redis.volumeSize | 500Mi | | While setting up the stateful deployment, while creating the persistant volume, volume allocation size need to be provided. This key helps you set the volume allocation size. Unit of this value must be in Mi (megabyte) or Gi (gigabyte) |
| services.redis.assign_cluster_ip | false | | Set it to `true` if you want to assign `ClusterIP` to the service |
| env.remote_redis_url | | | Users can also decide to use the remote hosted database and link to Plane deployment. Ignoring all the above keys, set `services.redis.local_setup` to `false` and set this key with remote connection url. |

### Doc Store (Minio/S3) Setup
Expand All @@ -149,6 +151,7 @@
| services.minio.root_password | password | | Storage credentials are requried to access the hosted stateful deployment of `minio`. Use this key to set the password for the stateful deployment. |
| env.docstore_bucket | uploads | Yes | Storage bucket name is required as part of configuration. This is where files will be uploaded irrespective of if you are using `Minio` or external `S3` (or compatible) storage service |
| env.doc_upload_size_limit | 5242880 | Yes | Document Upload Size Limit (default to 5Mb) |
| services.minio.assign_cluster_ip | false | | Set it to `true` if you want to assign `ClusterIP` to the service |
| env.aws_access_key | | | External `S3` (or compatible) storage service provides `access key` for the application to connect and do the necessary upload/download operations. To be provided when `services.minio.local_setup=false` |
| env.aws_secret_access_key | | | External `S3` (or compatible) storage service provides `secret access key` for the application to connect and do the necessary upload/download operations. To be provided when `services.minio.local_setup=false` |
| env.aws_region | | | External `S3` (or compatible) storage service providers creates any buckets in user selected region. This is also shared with the user as `region` for the application to connect and do the necessary upload/download operations. To be provided when `services.minio.local_setup=false` |
Expand All @@ -162,6 +165,7 @@
| services.web.memoryLimit | 1000Mi | | Every deployment in kubernetes can be set to use maximum memory they are allowed to use. This key sets the memory limit for this deployment to use.|
| services.web.cpuLimit | 500m | | Every deployment in kubernetes can be set to use maximum cpu they are allowed to use. This key sets the cpu limit for this deployment to use.|
| services.web.image| registry.plane.tools/plane/web-enterprise | | This deployment needs a preconfigured docker image to function. Docker image name is provided by the owner and must not be changed for this deployment |
| services.web.assign_cluster_ip | false | | Set it to `true` if you want to assign `ClusterIP` to the service |

### Space Deployment

Expand All @@ -171,6 +175,7 @@
| services.space.memoryLimit | 1000Mi | | Every deployment in kubernetes can be set to use maximum memory they are allowed to use. This key sets the memory limit for this deployment to use.|
| services.space.cpuLimit | 500m | | Every deployment in kubernetes can be set to use maximum cpu they are allowed to use. This key sets the cpu limit for this deployment to use.|
| services.space.image| registry.plane.tools/plane/space-enterprise | | This deployment needs a preconfigured docker image to function. Docker image name is provided by the owner and must not be changed for this deployment |
| services.space.assign_cluster_ip | false | | Set it to `true` if you want to assign `ClusterIP` to the service |

### Admin Deployment

Expand All @@ -180,6 +185,7 @@
| services.admin.memoryLimit | 1000Mi | | Every deployment in kubernetes can be set to use maximum memory they are allowed to use. This key sets the memory limit for this deployment to use.|
| services.admin.cpuLimit | 500m | | Every deployment in kubernetes can be set to use maximum cpu they are allowed to use. This key sets the cpu limit for this deployment to use.|
| services.admin.image| registry.plane.tools/plane/admin-enterprise | | This deployment needs a preconfigured docker image to function. Docker image name is provided by the owner and must not be changed for this deployment |
| services.admin.assign_cluster_ip | false | | Set it to `true` if you want to assign `ClusterIP` to the service |

### API Deployment

Expand All @@ -191,6 +197,7 @@
| services.api.image| registry.plane.tools/plane/backend-enterprise | | This deployment needs a preconfigured docker image to function. Docker image name is provided by the owner and must not be changed for this deployment |
| env.sentry_dsn | | | (optional) API service deployment comes with some of the preconfigured integration. Sentry is one among those. Here user can set the Sentry provided DSN for this integration.|
| env.sentry_environment | | | (optional) API service deployment comes with some of the preconfigured integration. Sentry is one among those. Here user can set the Sentry environment name (as configured in Sentry) for this integration.|
| services.api.assign_cluster_ip | false | | Set it to `true` if you want to assign `ClusterIP` to the service |

### Worker Deployment

Expand Down
Loading

0 comments on commit 581556b

Please sign in to comment.