Merge pull request #44 from makeplane/develop

Promoting develop to master

charts/plane-enterprise/Chart.yaml

@@ -5,8 +5,8 @@ description: Meet Plane. An Enterprise software development tool to manage issue
 
 type: application
 
-version: 1.0.11
-appVersion: "1.3.0"
+version: 1.0.12
+appVersion: "1.3.1"
 
 home: https://plane.so/
 icon: https://plane.so/favicon/favicon-32x32.png

charts/plane-enterprise/README.md

@@ -84,22 +84,22 @@
 
 ## Available customizations
 
-### Docker registry
+<!-- ### Docker registry
 
 | Setting | Default | Required | Description |
 |---|:---:|:---:|---|
 | dockerRegistry.enabled | false |  | Plane uses a private Docker registry which needs authenticated login. This must be set to `true` to install Plane Enterprise. |
 | dockerRegistry.registry |  registry.plane.tools| Yes | The host that will serve the required Docker images; Don't change this. |
 | dockerRegistry.loginid |  | Yes | Sets the `loginid` for the Docker registry. This is the same as the REG_USER_ID value on prime. plane.so |
 | dockerRegistry.password |  | Yes | Sets the `password` for the Docker registry. This is the same as the REG_PASSWORD value on prime.plane.so|
-  
+   -->
 ### License
 
 | Setting | Default | Required | Description |
 |---|:---:|:---:|---|
-| planeVersion | v1.2.1 | Yes |  Specifies the version of Plane to be deployed. Copy this from prime.plane.so. |
+| planeVersion | v1.3.1 | Yes |  Specifies the version of Plane to be deployed. Copy this from prime.plane.so. |
 | license.licenseServer | <https://prime.plane.so> | Yes | Sets the value of the `licenseServer` that gets you your license and validates it periodically. Don't change this. |
-| license.licenseDomain | 'plane.example.com' | Yes | The fully-qualified domain name (FQDN) in the format `sudomain.domain.tld` or `domain.tld` that the license is bound to. It is also attached to your `ingress` host to access Plane. |
+| license.licenseDomain | plane.example.com | Yes | The fully-qualified domain name (FQDN) in the format `sudomain.domain.tld` or `domain.tld` that the license is bound to. It is also attached to your `ingress` host to access Plane. |
 
 ### Postgres
 
@@ -127,6 +127,20 @@
 | 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. |
 
+### RabbitMQ Setup
+
+| Setting | Default | Required | Description |
+|---|:---:|:---:|---|
+| services.rabbitmq.local_setup | true |  | Plane uses `rabbitmq` as message queuing system. This can be hosted within kubernetes as part of helm chart deployment or can be used as hosted service remotely (e.g. aws mq or similar services). Set this to  `true` when you choose to setup stateful deployment of `rabbitmq`. Mark it as `false` when using a remotely hosted service |
+| services.rabbitmq.image | rabbitmq:3.13.6-management-alpine |  | Using this key, user must provide the docker image name to setup the stateful deployment of `rabbitmq`. (must be set when `services.rabbitmq.local_setup=true`)|
+| services.rabbitmq.servicePort | 5672 |  | This key sets the default port number to be used while setting up stateful deployment of `rabbitmq`. |
+| services.rabbitmq.managementPort | 15672 |  | This key sets the default management port number to be used while setting up stateful deployment of `rabbitmq`. |
+| services.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) |
+| services.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. |
+| services.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. |
+| services.rabbitmq.assign_cluster_ip | false |  | Set it to `true` if you want to assign `ClusterIP` to the service |
+| services.rabbitmq.external_rabbitmq_url |  |  | Users can also decide to use the remote hosted service and link to Plane deployment. Ignoring all the above keys, set `services.rabbitmq.local_setup` to `false` and set this key with remote connection url. |
+
 ### Doc Store (Minio/S3) Setup
 
 | Setting | Default | Required | Description |
@@ -251,13 +265,14 @@
 
 If you are planning to use 3rd party ingress providers, here is the available route configuration
 
-| Host | Path | Service |
-|---    |:---:|---|
-| plane.example.com | /  | <http://plane-app-web.plane:3000> |
-| plane.example.com | /spaces/*  | <http://plane-app-space.plane:3000> |
-| plane.example.com | /god-mode/* | <http://plane-app-admin.plane:3000> |
-| plane.example.com | /live/* | <http://plane-app-live.plane:3000> |
-| plane.example.com | /api/*  |  <http://plane-app-api.plane:8000> |
-| plane.example.com | /auth/* | <http://plane-app-api.plane:8000> |
-| plane.example.com | /uploads/* | <http://plane-app-minio.plane:9000> |
-| plane-minio.example.com | / | <http://plane-app-minio.plane:9090> |
+| Host | Path | Service | Required |
+|---    |:---:|---|:--- |
+| plane.example.com | /  | <http://plane-app-web.plane:3000> | Yes |
+| plane.example.com | /spaces/*  | <http://plane-app-space.plane:3000> | Yes |
+| plane.example.com | /god-mode/* | <http://plane-app-admin.plane:3000> | Yes |
+| plane.example.com | /live/* | <http://plane-app-live.plane:3000> | Yes |
+| plane.example.com | /api/*  |  <http://plane-app-api.plane:8000> | Yes |
+| plane.example.com | /auth/* | <http://plane-app-api.plane:8000> | Yes |
+| plane.example.com | /uploads/* | <http://plane-app-minio.plane:9000> | Yes (Only if using local setup) |
+| plane-minio.example.com | / | <http://plane-app-minio.plane:9090> | (Optional) if using local setup, this will enable minio console access |
+| plane-mq.example.com | / | <http://plane-app-minio.plane:15672> | (Optional) if using local setuo, this will enable management console access |

charts/plane-enterprise/questions.yml

@@ -353,11 +353,6 @@ questions:
     type: boolean
     default: false
     show_if: "services.rabbitmq.local_setup=true"
-  - variable: services.rabbitmq.storageClass
-    label: "Storage Class"
-    type: string
-    default: "longhorn"
-    show_if: "services.rabbitmq.local_setup=true"
   - variable: services.rabbitmq.volumeSize
     label: "Volume Size"
     type: string

charts/plane-enterprise/templates/workloads/monitor.stateful.yaml

@@ -32,6 +32,8 @@ spec:
     metadata:
       labels:
         app.name: {{ .Release.Namespace }}-{{ .Release.Name }}-monitor
+      annotations:
+        timestamp: {{ now | quote }}
     spec:
       containers:
       - image: {{ .Values.services.monitor.image | default "registry.plane.tools/plane/monitor-enterprise" }}:{{ .Values.planeVersion }}

charts/plane-enterprise/templates/workloads/rabbitmq.stateful.yaml

@@ -67,7 +67,7 @@ spec:
       resources:
         requests:
           storage: {{ .Values.services.rabbitmq.volumeSize | default "100Mi" | quote }}
-      storageClassName: {{ .Values.services.rabbitmq.storageClass }}
+      storageClassName: {{ .Values.env.storageClass }}
       volumeMode: Filesystem
 
 {{- end }}

charts/plane-enterprise/values.yaml

@@ -1,4 +1,4 @@
-planeVersion: v1.3.0
+planeVersion: v1.3.1
 
 dockerRegistry:
   enabled: false
@@ -48,7 +48,6 @@ services:
     image: rabbitmq:3.13.6-management-alpine
     servicePort: 5672
     managementPort: 15672
-    storageClass: longhorn
     volumeSize: 100Mi
     default_user: plane
     default_password: plane