Osclass

Osclass is a PHP script that allows you to quickly create and manage your own free classifieds site. Using this script, you can provide free advertising for items for sale, real estate, jobs, cars... Hundreds of free classified advertising sites are using Osclass.

This Helm chart is deprecated

Given the stable deprecation timeline, the Bitnami maintained Osclass Helm chart is now located at bitnami/charts.

The Bitnami repository is already included in the Hubs and we will continue providing the same cadence of updates, support, etc that we've been keeping here these years. Installation instructions are very similar, just adding the bitnami repo and using it during the installation (bitnami/<chart> instead of stable/<chart>)

bash

$ helm repo add bitnami https://charts.bitnami.com/bitnami
$ helm install my-release bitnami/<chart>           # Helm 3
$ helm install --name my-release bitnami/<chart>    # Helm 2

To update an exisiting stable deployment with a chart hosted in the bitnami repository you can execute

bash

$ helm repo add bitnami https://charts.bitnami.com/bitnami
$ helm upgrade my-release bitnami/<chart>

Issues and PRs related to the chart itself will be redirected to bitnami/charts GitHub repository. In the same way, we'll be happy to answer questions related to this migration process in this issue created as a common place for discussion.

TL;DR;

console

$ helm install my-release stable/osclass

Introduction

This chart bootstraps an Osclass deployment on a Kubernetes cluster using the Helm package manager.

It also packages the Bitnami MariaDB chart which is required for bootstrapping a MariaDB deployment for the database requirements of the Osclass application.

Bitnami charts can be used with Kubeapps for deployment and management of Helm Charts in clusters. This chart has been tested to work with NGINX Ingress, cert-manager, fluentd and Prometheus on top of the BKPR.

Prerequisites

Kubernetes 1.12+
Helm 2.11+ or Helm 3.0-beta3+
PV provisioner support in the underlying infrastructure
ReadWriteMany volumes for deployment scaling

Installing the Chart

To install the chart with the release name my-release:

console

$ helm install my-release stable/osclass

The command deploys Osclass on the Kubernetes cluster in the default configuration. The Parameters section lists the parameters that can be configured during installation.

Tip: List all releases using helm list

Uninstalling the Chart

To uninstall/delete the my-release deployment:

console

$ helm delete my-release

The command removes all the Kubernetes components associated with the chart and deletes the release.

Parameters

The following table lists the configurable parameters of the Osclass chart and their default values.

Parameter	Description	Default
`global.imageRegistry`	Global Docker image registry	`nil`
`global.imagePullSecrets`	Global Docker registry secret names as an array	`[]` (does not add image pull secrets to deployed pods)
`global.storageClass`	Global storage class for dynamic provisioning	`nil`
`image.registry`	Osclass image registry	`docker.io`
`image.repository`	Osclass Image name	`bitnami/osclass`
`image.tag`	Osclass Image tag	`{TAG_NAME}`
`image.pullPolicy`	Image pull policy	`IfNotPresent`
`image.pullSecrets`	Specify docker-registry secret names as an array	`[]` (does not add image pull secrets to deployed pods)
`nameOverride`	String to partially override osclass.fullname template with a string (will prepend the release name)	`nil`
`fullnameOverride`	String to fully override osclass.fullname template with a string	`nil`
`osclassHost`	Osclass host to create application URLs	`nil`
`osclassLoadBalancerIP`	`loadBalancerIP` for the Osclass Service	`nil`
`osclassUsername`	User of the application	`user`
`osclassPassword`	Application password	`bitnami`
`osclassEmail`	Admin email	`[email protected]`
`osclassWebTitle`	Application tittle	`Sample Web Page`
`osclassPingEngines`	Allow site to appear in search engines	`1`
`osclassSaveStats`	Send statistics and reports to Osclass	`1`
`smtpHost`	SMTP host	`nil`
`smtpPort`	SMTP port	`nil`
`smtpUser`	SMTP user	`nil`
`smtpPassword`	SMTP password	`nil`
`smtpProtocol`	SMTP protocol [`ssl`, `tls`]	`nil`
`serviceType`	Kubernetes Service type	`LoadBalancer`
`resources`	CPU/Memory resource requests/limits	Memory: `512Mi`, CPU: `300m`
`persistence.enabled`	Enable persistence using PVC	`true`
`persistence.moodle.storageClass`	PVC Storage Class for OSClass volume	`nil` (uses alpha storage class annotation)
`persistence.moodle.accessMode`	PVC Access Mode for OSClass volume	`ReadWriteOnce`
`persistence.moodle.size`	PVC Storage Request for OSClass volume	`8Gi`
`allowEmptyPassword`	Allow DB blank passwords	`yes`
`externalDatabase.host`	Host of the external database	`nil`
`externalDatabase.port`	Port of the external database	`3306`
`externalDatabase.user`	Existing username in the external db	`bn_osclass`
`externalDatabase.password`	Password for the above username	`nil`
`externalDatabase.database`	Name of the existing database	`bitnami_osclass`
`ingress.enabled`	Enable ingress controller resource	`false`
`ingress.annotations`	Ingress annotations	`[]`
`ingress.certManager`	Add annotations for cert-manager	`false`
`ingress.hosts[0].name`	Hostname to your osclass installation	`osclass.local`
`ingress.hosts[0].path`	Path within the url structure	`/`
`ingress.hosts[0].tls`	Utilize TLS backend in ingress	`false`
`ingress.hosts[0].tlsHosts`	Array of TLS hosts for ingress record (defaults to `ingress.hosts[0].name` if `nil`)	`nil`
`ingress.hosts[0].tlsSecret`	TLS Secret (certificates)	`osclass.local-tls-secret`
`ingress.secrets[0].name`	TLS Secret Name	`nil`
`ingress.secrets[0].certificate`	TLS Secret Certificate	`nil`
`ingress.secrets[0].key`	TLS Secret Key	`nil`
`mariadb.enabled`	Whether to use the MariaDB chart	`true`
`mariadb.db.name`	Database name to create	`bitnami_osclass`
`mariadb.db.user`	Database user to create	`bn_osclass`
`mariadb.mariadbPassword`	Password for the database	`nil`
`mariadb.mariadbRootPassword`	MariaDB admin password	`nil`
`mariadb.persistence.enabled`	Enable MariaDB persistence using PVC	`true`
`mariadb.persistence.storageClass`	PVC Storage Class for MariaDB volume	`generic`
`mariadb.persistence.accessMode`	PVC Access Mode for MariaDB volume	`ReadWriteOnce`
`mariadb.persistence.size`	PVC Storage Request for MariaDB volume	`8Gi`
`podAnnotations`	Pod annotations	`{}`
`affinity`	Map of node/pod affinities	`{}`
`metrics.enabled`	Start a side-car prometheus exporter	`false`
`metrics.image.registry`	Apache exporter image registry	`docker.io`
`metrics.image.repository`	Apache exporter image name	`bitnami/apache-exporter`
`metrics.image.tag`	Apache exporter image tag	`{TAG_NAME}`
`metrics.image.pullPolicy`	Image pull policy	`IfNotPresent`
`metrics.image.pullSecrets`	Specify docker-registry secret names as an array	`[]` (does not add image pull secrets to deployed pods)
`metrics.podAnnotations`	Additional annotations for Metrics exporter pod	`{prometheus.io/scrape: "true", prometheus.io/port: "9117"}`
`metrics.resources`	Exporter resource requests/limit	{}

The above parameters map to the env variables defined in bitnami/osclass. For more information please refer to the bitnami/osclass image documentation.

Note:

For Osclass to function correctly, you should specify the osclassHost parameter to specify the FQDN (recommended) or the public IP address of the Osclass service.

Optionally, you can specify the osclassLoadBalancerIP parameter to assign a reserved IP address to the Osclass service of the chart. However please note that this feature is only available on a few cloud providers (f.e. GKE).

To reserve a public IP address on GKE:
bash
$ gcloud compute addresses create osclass-public-ip
The reserved IP address can be associated to the Osclass service by specifying it as the value of the osclassLoadBalancerIP parameter while installing the chart.

Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,

console

$ helm install my-release \
  --set osclassUsername=admin,osclassPassword=password,mariadb.mariadbRootPassword=secretpassword \
    stable/osclass

The above command sets the Osclass administrator account username and password to admin and password respectively. Additionally, it sets the MariaDB root user password to secretpassword.

Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,

console

$ helm install my-release -f values.yaml stable/osclass

Tip: You can use the default values.yaml

Configuration and installation details

Rolling VS Immutable tags

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.

Bitnami will release a new chart updating its containers if a new version of the main container, significant changes, or critical vulnerabilities exist.

Persistence

The Bitnami 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 Parameters section to configure the PVC or to disable persistence.

Upgrading

To 7.0.0

Helm performs a lookup for the object based on its group (apps), version (v1), and kind (Deployment). Also known as its GroupVersionKind, or GVK. Changing the GVK is considered a compatibility breaker from Kubernetes' point of view, so you cannot "upgrade" those objects to the new GVK in-place. Earlier versions of Helm 3 did not perform the lookup correctly which has since been fixed to match the spec.

In https://github.com/helm/charts/pull/17303 the apiVersion of the deployment resources was updated to apps/v1 in tune with the api's deprecated, resulting in compatibility breakage.

This major version signifies this change.

To 3.0.0

Backwards compatibility is not guaranteed unless you modify the labels used on the chart's deployments. Use the workaround below to upgrade from versions previous to 3.0.0. The following example assumes that the release name is osclass:

console

$ kubectl patch deployment osclass-osclass --type=json -p='[{"op": "remove", "path": "/spec/selector/matchLabels/chart"}]'
$ kubectl delete statefulset osclass-mariadb --cascade=false