Merge pull request #134 from cscetbon/snyk-fix-177b60d8f260d8de05f734…

…7f2f6190f6
cscetbon · Dec 7, 2023 · 309d642 · 309d642
2 parents c62502d + 0c31f85
commit 309d642
Show file tree

Hide file tree

Showing 11 changed files with 3,634 additions and 4,241 deletions.
diff --git a/website/docs/2_setup/1_getting_started.md b/website/docs/2_setup/1_getting_started.md
@@ -2,8 +2,6 @@
 title: Getting Started
 sidebar_label: Getting Started
 ---
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
 
 CassKop uses the standard Cassandra image (tested up to Version 3.11), and can run on Kubernetes 1.13.3+.
 

diff --git a/website/docs/2_setup/3_multi_casskop.md b/website/docs/2_setup/3_multi_casskop.md
@@ -2,8 +2,6 @@
 title: Multi-CassKop
 sidebar_label: Multi-CassKop
 ---
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
 
 ## MultiCasskop
 
@@ -39,7 +37,7 @@ In order to allow our Multi-CassKop controller to have access to k8s-cluster-2 f
 kubemcsa export --context=cluster2 --namespace cassandra-e2e casskop --as k8s-cluster2 | kubectl apply -f -
 ```
 
-:::tips
+:::tip
 This will create in current k8s (k8s-cluster-1) the k8s secret associated to the
 **casskop** service account of namespace **cassandra-e2e** in k8s-cluster2.
 /!\ The Secret will be created with the name **k8s-cluster2** and this name must be used when starting Multi-CassKop and

diff --git a/website/docs/2_setup/5_upgrade_v1_to_v2.md b/website/docs/2_setup/5_upgrade_v1_to_v2.md
@@ -2,8 +2,6 @@
 title: Upgrade v1 to v2
 sidebar_label: Upgrade v1 to v2
 ---
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
 
 Version 2 makes it possible to use Cassandra 3 and 4 using the same bootstrap image. That's why it's recommended to
 upgrade to version 2.

diff --git a/website/docs/3_configuration_deployment/11_cassandra_cluster_status.md b/website/docs/3_configuration_deployment/11_cassandra_cluster_status.md
@@ -80,11 +80,11 @@ The CassandraCluster prints out it's whole status.
 - **lastClusterAction** Is the Last Action at the Cluster level
 - **lastClusterActionStatus** Is the Last Action Status at the Cluster level
 - **CassandraNodeStatus**: represents a map of (hostId, Ip Node) couple for each Pod in the Cluster
-  - **${Cassandra node pod's name}**
+  - **$\{Cassandra node pod's name\}**
     - **HostId**: the cassandra node's hostId
     - **IpNode**: the cassandra node's ip
 - **CassandraRackStatus** represents a map of statuses for each of the Cassandra Racks in the Cluster
-  - **${Cassandra DC-Rack Name}**
+  - **$\{Cassandra DC-Rack Name\}**
     - **Cassandra Last Action**: it's an action which is ongoing on the Cassandra cluster :
         - **Name**: name of the Action
             - **UpdateConfigMap** a new ConfigMap has been submitted to the cluster

diff --git a/website/docs/3_configuration_deployment/1_customizable_install_with_helm.md b/website/docs/3_configuration_deployment/1_customizable_install_with_helm.md
@@ -2,8 +2,6 @@
 title: Customizable install with Helm
 sidebar_label: Customizable install with Helm
 ---
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
 
 This Helm chart installs CassKop to create/configure/manage Cassandra
 clusters in a Kubernetes Namespace.
@@ -16,21 +14,21 @@ which implements a `CassandraCluster` object in Kubernetes.
 
 The following tables lists the configurable parameters of the Cassandra Operator Helm chart and their default values.
 
-| Parameter                        | Description                                      | Default                                   |
-|----------------------------------|--------------------------------------------------|-------------------------------------------|
-| `image.repository`               | Image                                            | `ghcr.io/cscetbon/casskop`                |
-| `image.tag`                      | Image tag                                        | `v2.0.1-release`                          |
-| `image.pullPolicy`               | Image pull policy                                | `Always`                                  |
-| `image.imagePullSecrets.enabled` | Enable the use of secret for docker image        | `false`                                   |
-| `image.imagePullSecrets.name`    | Name of the secret to connect to docker registry | -                                         |
-| `createCustomResource`           | If true, create & deploy the CRD                 | `true`
-| `rbacEnable`                     | If true, create & use RBAC resources             | `true`                                    |
-| `readinessProbe.timeouts.initialDelaySeconds` | Specifies timeout before first probe attempt | `4`				  |
-| `readinessProbe.timeouts.periodSeconds` | Specifies probe interval                  | `10`                                      |
-| `readinessProbe.timeouts.failureThreshold` | When a probe fails, after time specified in this field Pod will be marked as `Undready`  | `1`                              |
-| `resources`                      | Pod resource requests & limits                   | `{requests: {cpu: 10m, memory: 50Mi}, limits: {cpu: 1,memory: 512Mi}`               |
-| `metricService`                  | deploy service for metrics                       | `false`                                   |
-| `debug.enabled`                  | activate DEBUG log level  and enable shareProcessNamespace (allowing ephemeral container usage)              | `false`                                   |
+| Parameter                        | Description                                      | Default                                                                |
+|----------------------------------|--------------------------------------------------|------------------------------------------------------------------------|
+| `image.repository`               | Image                                            | `ghcr.io/cscetbon/casskop`                                             |
+| `image.tag`                      | Image tag                                        | `v2.0.1-release`                                                       |
+| `image.pullPolicy`               | Image pull policy                                | `Always`                                                               |
+| `image.imagePullSecrets.enabled` | Enable the use of secret for docker image        | `false`                                                                |
+| `image.imagePullSecrets.name`    | Name of the secret to connect to docker registry | -                                                                      |
+| `createCustomResource`           | If true, create & deploy the CRD                 | `true`                                                                 
+| `rbacEnable`                     | If true, create & use RBAC resources             | `true`                                                                 |
+| `readinessProbe.timeouts.initialDelaySeconds` | Specifies timeout before first probe attempt | `4`				                                                                |
+| `readinessProbe.timeouts.periodSeconds` | Specifies probe interval                  | `10`                                                                   |
+| `readinessProbe.timeouts.failureThreshold` | When a probe fails, after time specified in this field Pod will be marked as `Undready`  | `1`                                                                    |
+| `resources`                      | Pod resource requests & limits                   | `{requests: {cpu: 10m, memory: 50Mi}, limits: {cpu: 1,memory: 512Mi}}` |
+| `metricService`                  | deploy service for metrics                       | `false`                                                                |
+| `debug.enabled`                  | activate DEBUG log level  and enable shareProcessNamespace (allowing ephemeral container usage)              | `false`                                                                |
 
 Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
 
@@ -42,34 +40,17 @@ helm install casskop oci://ghcr.io/cscetbon/casskop-helm -f values.yaml
 
 ### Installing the Chart
 
-
-<Tabs
-  defaultValue="dryrun"
-  values={[
-    { label: 'dry run', value: 'dryrun', },
-    { label: 'release name', value: 'rn', },
-  ]
-}>
-<TabItem value="dryrun">
-
 ```bash
 helm install --dry-run \
     --debug.enabled oci://ghcr.io/cscetbon/casskop-helm \
     --set debug.enabled=true \
     --name casskop
 ```
 
-</TabItem>
-<TabItem value="rn">
-
 ```bash
 helm install casskop oci://ghcr.io/cscetbon/casskop-helm
 ```
 
-</TabItem>
-
-</Tabs>
-
 > the `-replace` flag allow you to reuse a charts release name
 
 ### Listing deployed charts

diff --git a/website/docs/5_operations/0_implementation_architecture.md b/website/docs/5_operations/0_implementation_architecture.md
@@ -107,7 +107,7 @@ Example for DC `dc1-rack1` :
 - The services will be names : `cassandra-demo-dc1` and `cassandra-demo-dc2`
 - the associated service for Prometheus metrics export will be named :
   `cassandra-demo-dc1-exporter-jmx`,`cassandra-demo-dc2-exporter-jmx`  
-- the PVC (Persistent Volume Claim) of each pod will be named **data-${podName}** ex: `data-cassandra-demo-dc1-rack1-0`
+- the PVC (Persistent Volume Claim) of each pod will be named **data-$\{podName\}** ex: `data-cassandra-demo-dc1-rack1-0`
   for each dc-rack
 - the [PodDisruptionBudget (PDB)](https://kubernetes.io/docs/tasks/run-application/configure-pdb/) will be named :
   `cassandra-demo` and will target all pods of the cluster

diff --git a/website/docs/6_references/3_cassandra_cluster_status.md b/website/docs/6_references/3_cassandra_cluster_status.md
@@ -7,14 +7,14 @@ sidebar_label: Cassandra cluster Status
 
 [Check documentation for more informations](/casskop/docs/configuration_deployment/cassandra_cluster_status)
 
-|Field|Type|Description|Required|Default|
-|-----|----|-----------|--------|--------|
-|phase|string| Indicates the state this Cassandra cluster jumps in. Phase goes as one way as below: Initial -> Running <-> updating.|Yes| - |
-|lastClusterAction|string|Is the Last Action at the Cluster level|Yes| - |
-|lastClusterActionStatus|string|Is the Last Action Status at the Cluster level|Yes|-|
-|seedlist|\[ \]string|it is the Cassandra SEED List used in the Cluster.|Yes|-|
-|cassandraNodeStatus|map\[string\][CassandraNodeStatus](#cassandranodestatus)|represents a map of (hostId, Ip Node) couple for each Pod in the Cluster.|Yes| - |
-|cassandraRackStatus|map\[string\][CassandraRackStatus](#cassandrarackstatus)|represents a map of statuses for each of the Cassandra Racks in the Cluster|Yes|-|
+|Field|Type| Description                                                                                                            |Required|Default|
+|-----|----|------------------------------------------------------------------------------------------------------------------------|--------|--------|
+|phase|string| Indicates the state this Cassandra cluster jumps in. Phase goes as one way as below: Initial \> Running \<\> updating. |Yes| - |
+|lastClusterAction|string| Is the Last Action at the Cluster level                                                                                |Yes| - |
+|lastClusterActionStatus|string| Is the Last Action Status at the Cluster level                                                                         |Yes|-|
+|seedlist|\[ \]string| it is the Cassandra SEED List used in the Cluster.                                                                     |Yes|-|
+|cassandraNodeStatus|map\[string\][CassandraNodeStatus](#cassandranodestatus)| represents a map of (hostId, Ip Node) couple for each Pod in the Cluster.                                              |Yes| - |
+|cassandraRackStatus|map\[string\][CassandraRackStatus](#cassandrarackstatus)| represents a map of statuses for each of the Cassandra Racks in the Cluster                                            |Yes|-|
 
 ## CassandraNodeStatus
 
@@ -25,11 +25,11 @@ sidebar_label: Cassandra cluster Status
 
 ## CassandraRackStatus
 
-|Field|Type|Description|Required|Default|
-|-----|----|-----------|--------|--------|
-|phase|string| Indicates the state this Cassandra cluster jumps in. Phase goes as one way as below: Initial -> Running <-> updating.|Yes| - |
-|cassandraLastAction|[CassandraLastAction](#cassandralastaction)| Is the set of Cassandra State & Actions: Active, Standby..|Yes| - |
-|podLastOperation|[PodLastOperation](#podlastoperation)| manage status for Pod Operation (nodetool cleanup, upgradesstables..).|Yes| - |
+|Field|Type| Description                                                                                                            |Required|Default|
+|-----|----|------------------------------------------------------------------------------------------------------------------------|--------|--------|
+|phase|string| Indicates the state this Cassandra cluster jumps in. Phase goes as one way as below: Initial \> Running \<\> updating. |Yes| - |
+|cassandraLastAction|[CassandraLastAction](#cassandralastaction)| Is the set of Cassandra State & Actions: Active, Standby..                                                             |Yes| - |
+|podLastOperation|[PodLastOperation](#podlastoperation)| manage status for Pod Operation (nodetool cleanup, upgradesstables..).                                                 |Yes| - |
 
 ## CassandraLastAction
 
@@ -39,7 +39,7 @@ sidebar_label: Cassandra cluster Status
 |name|string|Type of action to perform : UpdateVersion, UpdateBaseImage, UpdateConfigMap.. |Yes| - |
 |startTime|[Time](https://godoc.org/github.com/ericchiang/k8s/apis/meta/v1#Time)| |Yes| - |
 |endTime|[Time](https://godoc.org/github.com/ericchiang/k8s/apis/meta/v1#Time)| |Yes| - |
-|updatedNodes|\[ \]string | PodNames of updated Cassandra nodes. Updated means the Cassandra container image version matches the spec's version.|Yes| - |
+|updatedNodes|[]string | PodNames of updated Cassandra nodes. Updated means the Cassandra container image version matches the spec's version.|Yes| - |
 
 ## PodLastOperation
 

diff --git a/website/docs/6_references/5_cassandra_backup.md b/website/docs/6_references/5_cassandra_backup.md
@@ -44,15 +44,15 @@ spec:
 
 ## CassandraBackupStatus
 
-|Field|Type|Description|Required|Default|
-|-----|----|-----------|--------|--------|
-|condition|[Condition](#condition)|BackRestCondition describes the observed state of a Restore at a certain point|Yes|-|
-|coordinatorMember|string|Name of the pod the restore operation is executed on|Yes|-|
-|id|string|unique identifier of an operation, a random id is assigned to each operation after a request is submitted, from caller's perspective, an id is sent back as a response to his request so he can further query state of that operation, referencing id, by operations/{id} endpoint|Yes|-|
-|progress|string|Progress is a percentage, 100% means the operation is completed, either successfully or with errors|Yes|-|
-|timeCompleted|string| |Yes|-|
-|timeCreated|string| |Yes|-|
-|timeStarted|string| |Yes|-|
+|Field|Type| Description                                                                                                                                                                                                                                                                          |Required|Default|
+|-----|----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------|--------|
+|condition|[Condition](#condition)| BackRestCondition describes the observed state of a Restore at a certain point                                                                                                                                                                                                       |Yes|-|
+|coordinatorMember|string| Name of the pod the restore operation is executed on                                                                                                                                                                                                                                 |Yes|-|
+|id|string| unique identifier of an operation, a random id is assigned to each operation after a request is submitted, from caller's perspective, an id is sent back as a response to his request so he can further query state of that operation, referencing id, by operations/\{id\} endpoint |Yes|-|
+|progress|string| Progress is a percentage, 100% means the operation is completed, either successfully or with errors                                                                                                                                                                                  |Yes|-|
+|timeCompleted|string|                                                                                                                                                                                                                                                                                      |Yes|-|
+|timeCreated|string|                                                                                                                                                                                                                                                                                      |Yes|-|
+|timeStarted|string|                                                                                                                                                                                                                                                                                      |Yes|-|
 
 ### Condition