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

fix: changed the storageClass to default #66

Merged
merged 5 commits into from
Dec 5, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 15 additions & 12 deletions charts/plane-ce/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
1. Set-up and customization

- Quick set-up<br>
This is the fastest way to deploy Plane with default settings. This will create stateful deployments for Postgres, Redis, and Minio with a persistent volume claim using the `longhorn` storage class. This also sets up the ingress routes for you using `nginx` ingress class.
This is the fastest way to deploy Plane with default settings. This will create stateful deployments for Postgres, Rabbitmq, Redis, and Minio with a persistent volume claim using the default storage class. This also sets up the ingress routes for you using `nginx` ingress class.
> To customize this, see `Custom ingress routes` below.

Continue to be on the same Terminal window as you have so far, copy the code below, and paste it on your Terminal screen.
Expand All @@ -29,19 +29,22 @@
--set ingress.minioHost="plane-minio.example.com" \
--set ingress.rabbitmqHost="plane-mq.example.com" \
--set ingress.ingressClass=nginx \
--set postgres.storageClass=longhorn \
--set redis.storageClass=longhorn \
--set minio.storageClass=longhorn \
--set rabbitmq.storageClass=longhorn \
--timeout 10m \
--wait \
--wait-for-jobs
```

> This is the minimum required to set up Plane-CE. You can change the default namespace from `plane-ce`, the default appname
from `plane-app`, the default storage class from `[postgres, redis, minio].storageClass`, and the default ingress class from `ingress.ingressClass` to whatever you would like to.<br> <br>
You can also pass other settings referring to `Configuration Settings` section.
> This is the basic setup required for Plane-CE. You can customize the default values for namespace and appname as needed. Additional settings can be configured by referring to the Configuration Settings section.<br>

**Using a Custom StorageClass**

To specify a custom StorageClass for Plane-CE components, add the following options to the above `helm upgrade --install` command:
```bash
--set postgres.storageClass=<your-storageclass-name>
--set redis.storageClass=<your-storageclass-name>
--set minio.storageClass=<your-storageclass-name>
--set rabbitmq.storageClass=<your-storageclass-name>
```
- Advance set-up<br>
For more control over your set-up, run the script below to download the `values.yaml` file and and edit using any editor like Vim or Nano.

Expand Down Expand Up @@ -85,7 +88,7 @@
| 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`|
| 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.storageClass | &lt;default-sc-on-k8s-cluster&gt; | | 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/Valkey Setup
Expand All @@ -98,7 +101,7 @@
| redis.servicePort | 6379 | | This key sets the default port number to be used while setting up stateful deployment of `redis`. |
| 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.storageClass | &lt;default-sc-on-k8s-cluster&gt; | | 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 |


Expand All @@ -112,7 +115,7 @@
| rabbitmq.servicePort | 5672 | | This key sets the default port number to be used while setting up stateful deployment of `rabbitmq`. |
| rabbitmq.managementPort | 15672 | | This key sets the default management port number to be used while setting up stateful deployment of `rabbitmq`. |
| rabbitmq.volumeSize | 100Mi | | 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) |
| rabbitmq.storageClass | longhorn | | Creating the persitant volumes for the stateful deployments needs the `storageClass` name. Set the correct value as per your kubernetes cluster configuration. |
| rabbitmq.storageClass | &lt;default-sc-on-k8s-cluster&gt; | | Creating the persitant volumes for the stateful deployments needs the `storageClass` name. Set the correct value as per your kubernetes cluster configuration. |
| rabbitmq.default_user | plane | | Credentials are requried to access the hosted stateful deployment of `rabbitmq`. Use this key to set the username for the stateful deployment. |
| rabbitmq.default_password | plane | | Credentials are requried to access the hosted stateful deployment of `rabbitmq`. Use this key to set the password for the stateful deployment. |
| rabbitmq.assign_cluster_ip | false | | Set it to `true` if you want to assign `ClusterIP` to the service |
Expand All @@ -135,7 +138,7 @@
| 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 `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 `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.storageClass | &lt;default-sc-on-k8s-cluster&gt; | | 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 Down
8 changes: 4 additions & 4 deletions charts/plane-ce/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ redis:
local_setup: true
image: valkey/valkey:7.2.5-alpine
servicePort: 6379
storageClass: longhorn
storageClass: ""
volumeSize: 100Mi
pullPolicy: IfNotPresent
assign_cluster_ip: false
Expand All @@ -38,7 +38,7 @@ postgres:
local_setup: true
image: postgres:15.7-alpine
servicePort: 5432
storageClass: longhorn
storageClass: ""
volumeSize: 1Gi
pullPolicy: IfNotPresent
assign_cluster_ip: false
Expand All @@ -49,7 +49,7 @@ rabbitmq:
pullPolicy: IfNotPresent
servicePort: 5672
managementPort: 15672
storageClass: longhorn
storageClass: ""
volumeSize: 100Mi
default_user: plane
default_password: plane
Expand All @@ -63,7 +63,7 @@ minio:
pullPolicy: IfNotPresent
root_password: password
root_user: admin
storageClass: longhorn
storageClass: ""
volumeSize: 1Gi
assign_cluster_ip: false

Expand Down
21 changes: 13 additions & 8 deletions charts/plane-enterprise/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
4. Set-up and customization
- Quick set-up

This is the fastest way to deploy Plane with default settings. This will create stateful deployments for Postgres, Redis/Valkey, and Minio with a persistent volume claim using the `longhorn` storage class. This also sets up the ingress routes for you using `nginx` ingress class.
This is the fastest way to deploy Plane with default settings. This will create stateful deployments for Postgres, Rabbitmq, Redis/Valkey, and Minio with a persistent volume claim using the default storage class.This also sets up the ingress routes for you using `nginx` ingress class.
> To customize this, see `Custom ingress routes` below.

Continue to be on the same Terminal window as you have so far, copy the code below, and paste it on your Terminal screen.
Expand All @@ -39,16 +39,21 @@
--set planeVersion=${PLANE_VERSION} \
--set ingress.enabled=true \
--set ingress.ingressClass=nginx \
--set env.storageClass=longhorn \
--timeout 10m \
--wait \
--wait-for-jobs
```

> This is the minimum required to set up Plane Enterprise. You can change the default namespace from `plane`, the default appname
from `plane-app`, the default storage class from `longhorn`, and the default ingress class from `nginx` to
whatever you would like to.<br> <br>
You can also pass other settings referring to `Configuration Settings` section.
> This is the basic setup required for Plane-EE. You can customize the default values for namespace and appname as needed. Additional settings can be configured by referring to the Configuration Settings section.<br>

**Using a Custom StorageClass**

To specify a custom StorageClass for Plane-Enterprise components, add the following options to the above `helm upgrade --install` command:
```bash
--set env.storageClass=<your-storageclass-name>
```



- Advance set-up

Expand All @@ -64,7 +69,7 @@
- `license.licenseDomain: <The domain you have specified to host Plane>`
- `ingress.enabled: <true | false>`
- `ingress.ingressClass: <nginx or any other ingress class configured in your cluster>`
- `env.storageClass: <longhorn or any other storage class configured in your cluster>`
- `env.storageClass: <default storage class configured in your cluster>`

> See `Available customizations` for more details.

Expand Down Expand Up @@ -266,7 +271,7 @@

| Setting | Default | Required | Description |
|---|:---:|:---:|---|
| env.storageClass | longhorn | | Creating the persitant volumes for the stateful deployments needs the `storageClass` name. Set the correct value as per your kubernetes cluster configuration. |
| env.storageClass | &lt;default-sc-on-k8s-cluster&gt; | | Creating the persitant volumes for the stateful deployments needs the `storageClass` name. Set the correct value as per your kubernetes cluster configuration. |
| 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|

## Custom Ingress Routes
Expand Down
2 changes: 1 addition & 1 deletion charts/plane-enterprise/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ env:
pgdb_name: plane
pgdb_remote_url: '' #INCASE OF REMOTE PG DB URL ONLY

storageClass: longhorn
storageClass: ''

# NEXT_PUBLIC_DEPLOY_URL: ''
# REDIS
Expand Down