Skip to content

The Unified and Autonomous Development Platform

docs: update readme to reflect changes

Khaliqda77bdd3e719
diff --git a/server-product/helm/README.md b/server-product/helm/README.md
index f209fe34ce..61be75de0b 100644
--- a/server-product/helm/README.md
+++ b/server-product/helm/README.md
@@ -13,7 +13,6 @@ All-In-One DevOps Platform
| affinity | object | `{}` | Configure [affinity and anti-affinity](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#affinity-and-anti-affinity). |
| args | list | `[]` | Override default image arguments. |
| command | list | `[]` | Override default image command. |
-| containerPorts | list | `[]` | Additional ContainerPorts array |
| database.dbHost | string | `""` | IP address or hostname of database |
| database.dbMaximumPoolSize | string | `"25"` | Database maximum pool size |
| database.dbName | string | `"onedev"` | Name of the database |
@@ -41,10 +40,10 @@ All-In-One DevOps Platform
| ingress.className | string | `""` | Specify the [ingressClassName](https://kubernetes.io/blog/2020/04/02/improvements-to-the-ingress-api-in-kubernetes-1.18/#specifying-the-class-of-an-ingress), requires Kubernetes >= 1.18. |
| ingress.enabled | bool | `false` | If **true**, create an Ingress resource. |
| ingress.hosts.host | string | `"onedev.example.com"` | Set the host name |
-| ingress.hosts.pathspath | string | `"/"` | |
-| ingress.hosts.pathspathType | string | `"ImplementationSpecific"` | |
-| ingress.hosts.pathsport.name | string | `"http"` | Specify the port name |
-| ingress.hosts.pathsport.number | string | `""` | Specify the port |
+| ingress.hosts.paths.path | string | `"/"` | |
+| ingress.hosts.paths.pathType | string | `"ImplementationSpecific"` | |
+| ingress.hosts.paths.port.name | string | `"http"` | Specify the port name |
+| ingress.hosts.paths.port.number | string | `""` | Specify the port number |
| ingress.tls | list | `[]` | Configure TLS for the Ingress. |
| initContainers | list | `[]` | Specify initContainers to be added. |
| lifecycle | object | `{}` | Specify lifecycle hooks for Containers. |
@@ -63,10 +62,10 @@ All-In-One DevOps Platform
| oneDevServer.trustCerts.path | string | `""` | Path of cert file on disk |
| oneDevServer.updateStrategy.type | string | `"RollingUpdate"` | valid options for statefulset `RollingUpdate`, `OnDelete` / Deployment: `RollingUpdate`, `Recreate` |
| oneDevServer.useStatefulSet | bool | `false` | Set to true to use a StatefulSet instead of a Deployment |
-| persistence.accessModes | list | `["ReadWriteOnce"]` | Specify the accessModes for PersistentVolumeClaims. |
+| persistence.accessModes | string | `"ReadWriteOnce"` | Specify the accessModes for PersistentVolumeClaims. |
| persistence.enabled | bool | `true` | If **true**, create and use PersistentVolumeClaims. |
| persistence.existingClaim | string | `""` | Name of an existing PersistentVolumeClaim to use. |
-| persistence.mountPath | string | `"/opt/onedev"` | Path inside the container where volume will be mounted |
+| persistence.selector | object | `{}` | Specify the selectors for PersistentVolumeClaims. |
| persistence.size | string | `"10Gi"` | Specify the size of PersistentVolumeClaims. |
| persistence.storageClassName | string | `""` | Specify the storageClassName for PersistentVolumeClaims. |
| podAnnotations | object | `{}` | Set annotations on Pods. |
@@ -75,7 +74,6 @@ All-In-One DevOps Platform
| podPriorityClassName | string | `""` | Set the [priorityClassName](https://kubernetes.io/docs/concepts/scheduling-eviction/pod-priority-preemption/#priorityclass). |
| podSecurityContext | object | `{}` | Allows you to overwrite the default [PodSecurityContext](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/). |
| readinessProbe | object | `{}` | Specify the readinessProbe [configuration](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). |
-| replicas | string | `"1"` | # only one replica as OneDev doesn't support clustering. default set to `1` |
| resources | object | `{}` | Specify resource requests and limits. |
| securityContext | object | `{}` | Specify securityContext for Containers. |
| service.annotations | object | `{}` | Specify annotations for the Service. |
@@ -84,8 +82,22 @@ All-In-One DevOps Platform
| service.ipFamilies | list | `[]` | Configure [IPv4/IPv6 dual-stack](https://kubernetes.io/docs/concepts/services-networking/dual-stack/). |
| service.ipFamilyPolicy | string | `""` | Configure [IPv4/IPv6 dual-stack](https://kubernetes.io/docs/concepts/services-networking/dual-stack/). |
| service.loadBalancerIP | string | `""` | Required: If service type is loadbalancer [loadBalancerIP](https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer). |
-| service.ports | object | `{}` | Manually change the ServicePorts |
-| service.topologyKeys | array | `nil` | Specify the [topologyKeys](https://kubernetes.io/docs/concepts/services-networking/service-topology/#using-service-topology). |
+| service.nodePort | string | `""` | Specify a nodePort for servcie |
+| service.ports | object | `{"httpPort":"","sshPort":""}` | Manually change the ServicePorts |
+| service.separateSSHService.annotations | object | `{}` | |
+| service.separateSSHService.clusterIP | string | `""` | |
+| service.separateSSHService.enabled | bool | `false` | If separate SSH service is enabled, a separate service is created for SSH |
+| service.separateSSHService.externalIPs | list | `[]` | |
+| service.separateSSHService.externalTrafficPolicy | string | `""` | |
+| service.separateSSHService.ipFamilies | list | `[]` | |
+| service.separateSSHService.ipFamilyPolicy | string | `""` | |
+| service.separateSSHService.loadBalancerIP | string | `""` | |
+| service.separateSSHService.loadBalancerSourceRanges | list | `[]` | |
+| service.separateSSHService.nodePort | string | `""` | |
+| service.separateSSHService.port | int | `22` | |
+| service.separateSSHService.topologyKeys | list | `[]` | |
+| service.separateSSHService.type | string | `"ClusterIP"` | |
+| service.topologyKeys | array | `[]` | Specify the [topologyKeys](https://kubernetes.io/docs/concepts/services-networking/service-topology/#using-service-topology). |
| service.type | string | `"ClusterIP"` | Specify the type for the Service. ClusterIP, LoadBalancer |
| serviceAccount.annotations | object | `{}` | Annotations to add to the ServiceAccount, if `serviceAccount.create` is **true**. |
| serviceAccount.create | bool | `true` | If **true**, create a ServiceAccount. |