[stable/osclass] Unify and refactor README.md (#18285)

Signed-off-by: Carlos Rodriguez Hernandez <crhernandez@bitnami.com>
This commit is contained in:
Carlos Rodríguez Hernández
2019-10-24 07:07:15 -07:00
committed by Kubernetes Prow Robot
parent a61d402a41
commit 47005da3c0
2 changed files with 6 additions and 4 deletions
+1 -1
View File
@@ -1,6 +1,6 @@
apiVersion: v1
name: osclass
version: 6.2.5
version: 6.2.6
appVersion: 3.7.4
description: Osclass is a php script that allows you to quickly create and manage
your own free classifieds site.
+5 -3
View File
@@ -31,7 +31,7 @@ To install the chart with the release name `my-release`:
$ helm install --name my-release stable/osclass
```
The command deploys Osclass on the Kubernetes cluster in the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation.
The command deploys Osclass on the Kubernetes cluster in the default configuration. The [Parameters](#parameters) section lists the parameters that can be configured during installation.
> **Tip**: List all releases using `helm list`
@@ -45,7 +45,7 @@ $ helm delete my-release
The command removes all the Kubernetes components associated with the chart and deletes the release.
## Configuration
## Parameters
The following table lists the configurable parameters of the Osclass chart and their default values.
@@ -151,6 +151,8 @@ $ helm install --name my-release -f values.yaml stable/osclass
> **Tip**: You can use the default [values.yaml](values.yaml)
## Configuration and installation details
### [Rolling VS Immutable tags](https://docs.bitnami.com/containers/how-to/understand-rolling-tags-containers/)
It is strongly recommended to use immutable tags in a production environment. This ensures your deployment does not change automatically if the same tag is updated with a different image.
@@ -162,7 +164,7 @@ Bitnami will release a new chart updating its containers if a new version of the
The [Bitnami Osclass](https://github.com/bitnami/bitnami-docker-osclass) image stores the Osclass data and configurations at the `/bitnami/osclass` path of the container.
Persistent Volume Claims are used to keep the data across deployments. This is known to work in GCE, AWS, and minikube.
See the [Configuration](#configuration) section to configure the PVC or to disable persistence.
See the [Parameters](#parameters) section to configure the PVC or to disable persistence.
## Upgrading