Skip to content

Commit

Permalink
pages content updatd with readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mguptahub committed Jul 3, 2024
1 parent 735681f commit 401b0b2
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 7 deletions.
2 changes: 1 addition & 1 deletion content/plane-ce.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@
| Setting | Default | Required | Description |
|---|:---:|:---:|---|
| redis.local_setup | true | | Plane uses `redis` to cache the session authentication and other static data. This database can be hosted within kubernetes as part of helm chart deployment or can be used as hosted service remotely (e.g. aws rds or similar services). Set this to `true` when you choose to setup stateful deployment of `redis`. Mark it as `false` when using a remotely hosted database |
| redis.image | redis:6.2.7-alpine | | Using this key, user must provide the docker image name to setup the stateful deployment of `redis`. (must be set when `redis.local_setup=true`)|
| redis.image | valkey/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 `redis.local_setup=true`)|
| 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. |
Expand Down
10 changes: 4 additions & 6 deletions content/plane-one.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
# Plane One Helm Chart

## Pre-requisite

- A Plane One license
> If you don’t have a license, get it <a href="https://prime.plane.so/" target="_blank">here</a>
> If you don’t have a license, get it at [prime.plane.so](https://prime.plane.so)
- A working Kubernetes cluster
- `kubectl` and `helm` on the client system that you will use to install our Helm charts

Expand Down Expand Up @@ -71,7 +69,7 @@
```

Make sure you set the minimum required values as below.
- `planeVersion: <v0.xx.x>`
- `planeVersion: <v1.xx.x>`
- `dockerRegistry.loginid: <REG_USER_ID as on prime.plane.so>`
- `dockerRegistry.password: <REG_PASSWORD as on prime.plane.so>`
- `license.licenseKey: <LICENSE_KEY as on prime.plane.so>`
Expand Down Expand Up @@ -109,7 +107,7 @@
| Setting | Default | Required | Description |
|---|:---:|:---:|---|
| planeVersion | vX.XX.X | Yes | Specifies the version of Plane to be deployed. Copy this from prime.plane.so. |
| planeVersion | v1.1.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.licenseKey | | Yes | Holds your license key to Plane One. Copy this from prime.plane.so. |
| 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. |
Expand All @@ -133,7 +131,7 @@
| Setting | Default | Required | Description |
|---|:---:|:---:|---|
| services.redis.local_setup | true | | Plane uses `redis` to cache the session authentication and other static data. This database can be hosted within kubernetes as part of helm chart deployment or can be used as hosted service remotely (e.g. aws rds or similar services). Set this to `true` when you choose to setup stateful deployment of `redis`. Mark it as `false` when using a remotely hosted database |
| services.redis.image | registry.plane.tools/plane/redis:7.2.4-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.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) |
| 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. |
Expand Down

0 comments on commit 401b0b2

Please sign in to comment.