From 188da803a7421fe84bf09ae7123e288853e76622 Mon Sep 17 00:00:00 2001 From: Amy Qualls Date: Thu, 19 Nov 2020 16:09:08 -0800 Subject: [PATCH 1/2] Fix spelling and formatting errors Fix some Kramdown formatting issues with unescaped characters, and catch a couple of spelling issues while I'm here. --- doc/charts/gitlab/mailroom/index.md | 20 ++++++++++---------- doc/charts/gitlab/migrations/index.md | 4 ++-- 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/doc/charts/gitlab/mailroom/index.md b/doc/charts/gitlab/mailroom/index.md index 216f1bafb7..8306121af4 100644 --- a/doc/charts/gitlab/mailroom/index.md +++ b/doc/charts/gitlab/mailroom/index.md @@ -79,27 +79,27 @@ serviceAccount: | `hpa.minReplicas` | Minimum number of replicas | `1` | | `hpa.maxReplicas` | Maximum number of replicas | `2` | | `hpa.cpu.targetAverageUtilization` | Target value of the average of the resource metric | `75` | -| `hpa.customMetrics` | autoscaling/v2beta1 Metrics contains the specifications for which to use to calculate the desired replica count (overrides the default use of Average CPU Utilization configured in `targetAverageUtilization`) | [] | +| `hpa.customMetrics` | autoscaling/v2beta1 Metrics contains the specifications for which to use to calculate the desired replica count (overrides the default use of Average CPU Utilization configured in `targetAverageUtilization`) | `[]` | | `image.pullPolicy` | Mailroom image pull policy | `IfNotPresent` | | `image.pullSecrets` | Mailroom image pull secrets | | | `image.repository` | Mailroom image repository | `registry.gitlab.com/gitlab-org/build/cng/gitlab-mailroom` | | `image.tag` | Mailroom image tag | `master` | | `init.image.repository` | Mailroom init image repository | | | `init.image.tag` | Mailroom init image tag | | -| `init.resources` | Mailroom init container resource requirements | { `requests`: { `cpu`: `50m` }} | -| `podLabels` | Labels for running Mailroom Pods | {} | -| `resources` | Mailroom resource requirements | { `requests`: { `cpu`: `50m`, `memory`: `150M` }} | -| `networkpolicy.annotations` | Annotations to add to the NetworkPolicy | {} | +| `init.resources` | Mailroom init container resource requirements | `{ requests: { cpu: 50m }}` | +| `podLabels` | Labels for running Mailroom Pods | `{}` | +| `resources` | Mailroom resource requirements | `{ requests: { cpu: 50m, memory: 150M }}` | +| `networkpolicy.annotations` | Annotations to add to the NetworkPolicy | `{}` | | `networkpolicy.egress.enabled` | Flag to enable egress rules of NetworkPolicy | `false` | -| `networkpolicy.egress.rules` | Define a list of egress rules for NetworkPolicy | [] | +| `networkpolicy.egress.rules` | Define a list of egress rules for NetworkPolicy | `[]` | | `networkpolicy.enabled` | Flag for using NetworkPolicy | `false` | | `networkpolicy.ingress.enabled` | Flag to enable `ingress` rules of NetworkPolicy | `false` | -| `networkpolicy.ingress.rules` | Define a list of `ingress` rules for NetworkPolicy | [] | +| `networkpolicy.ingress.rules` | Define a list of `ingress` rules for NetworkPolicy | `[]` | | `securityContext.fsGroup` | Group ID under which the pod should be started | `1000` | | `securityContext.runAsUser` | User ID under which the pod should be started | `1000` | -| `serviceAccount.annotations` | Annotations for ServiceAccount | {} | -| `serviceAccount.enabled` | Flag for using ServiceAccount | false | -| `serviceAccount.create` | Flag for creating a ServiceAccount | false | +| `serviceAccount.annotations` | Annotations for ServiceAccount | `{}` | +| `serviceAccount.enabled` | Flag for using ServiceAccount | `false` | +| `serviceAccount.create` | Flag for creating a ServiceAccount | `false` | | `serviceAccount.name` | Name of ServiceAccount to use | | | `tolerations` | Tolerations to add to the Mailroom | | diff --git a/doc/charts/gitlab/migrations/index.md b/doc/charts/gitlab/migrations/index.md index 59789c5992..12b38cfce8 100644 --- a/doc/charts/gitlab/migrations/index.md +++ b/doc/charts/gitlab/migrations/index.md @@ -57,7 +57,7 @@ Table below contains all the possible charts configurations that can be supplied | `extraInitContainers` | List of extra init containers to include | | | `extraContainers` | List of extra containers to include | | | `extraVolumes` | List of extra volumes to create | | -| `extraVolumeMounts` | List of extra volumes mountes to do | | +| `extraVolumeMounts` | List of extra volumes mounts to do | | | `extraEnv` | List of extra environment variables to expose | | | `bootsnap.enabled` | Enable the Bootsnap cache for Rails | `true` | @@ -75,7 +75,7 @@ extraEnv: SOME_OTHER_KEY: some_other_value ``` -When the container is started, you can confirm that the enviornment variables are exposed: +When the container is started, you can confirm that the environment variables are exposed: ```shell env | grep SOME -- GitLab From 50acd279503177d70a4e5c3cbb79b9388784e902 Mon Sep 17 00:00:00 2001 From: Marcel Amirault Date: Fri, 20 Nov 2020 00:21:04 +0000 Subject: [PATCH 2/2] Apply 1 suggestion(s) to 1 file(s) --- doc/charts/gitlab/mailroom/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/charts/gitlab/mailroom/index.md b/doc/charts/gitlab/mailroom/index.md index 8306121af4..6e9f8f5534 100644 --- a/doc/charts/gitlab/mailroom/index.md +++ b/doc/charts/gitlab/mailroom/index.md @@ -75,7 +75,7 @@ serviceAccount: | Parameter | Description | Default | |--------------------------------------|--------------------------------------------------|-----------------------------| -| `enabled` | Mailroom enablement flag | true | +| `enabled` | Mailroom enablement flag | `true` | | `hpa.minReplicas` | Minimum number of replicas | `1` | | `hpa.maxReplicas` | Maximum number of replicas | `2` | | `hpa.cpu.targetAverageUtilization` | Target value of the average of the resource metric | `75` | -- GitLab