Skip to content

Latest commit

 

History

History
 
 

osclass

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 

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.

TL;DR;

$ helm install stable/osclass

Introduction

This chart bootstraps a 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.

Prerequisites

  • Kubernetes 1.4+ with Beta APIs enabled
  • PV provisioner support in the underlying infrastructure

Installing the Chart

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 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:

$ helm delete my-release

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

Configuration

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

Parameter Description Default
imageTag bitnami/osclass image tag. Osclass image version
imagePullPolicy Image pull policy. IfNotPresent.
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 user@example.com
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.apache.storageClass PVC Storage Class for Apache volume nil (uses alpha storage class annotation)
persistence.apache.accessMode PVC Access Mode for Apache volume ReadWriteOnce
persistence.apache.size PVC Storage Request for Apache volume 1Gi
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
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

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:

$ 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,

$ helm install --name 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,

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

Tip: You can use the default values.yaml

Persistence

The Bitnami Osclass image stores the Osclass data and configurations at the /bitnami/osclass and /bitnami/apache paths 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 section to configure the PVC or to disable persistence.