urs-helm-chart

Project Description

This is the base helm chart for the URL Shortener application. URL shortener is the simple application which help users to get short url against the long url. It is designed to support the distributed system architecture.

Chart Dependency

1. Bitnami/Cassandra
2. Bitnami/Zookeeper

Development Setup

For building the project we need helm installed on your system. Helm has pretty comprehensive guide on installation and setup and can be found here.

Using the helm chart

Add the below block of code in your helm requirements.yaml file.

dependencies:
  - name: url-shortener
    repository: https://code-gambit.github.io/urs-helm-chart/charts
    version: 0.1.0

Parameters

For cassandra and zookeeper paramteters refer below bitnami doc.

• Cassandra
• Zookeeper

Common parameter

Name	Description	Default Value
common.image_pull_policy	Image pull policy for all the images	"Always"
common.memory.microservices	Memory allocation for the main services	"512M"

Connector main parameter

Name	Description	Default Value
connector_main.enabled	Boolean value to disable or enable service	true
connector_main.name	String for the service name	"connector-main"
connector_main.image	String value for the image	"codegb/urs-connector-main"
connector_main.root.port	Port at which tomcat server will run	8080
connector_main.cassandra.keyspace_name	Cassandra keysapce name	""
connector_main.cassandra.contact_point	Conssandra host name or IP	0.0.0.0
connector_main.cassandra.port	Cassandra port number for communication	9042
connector_main.cassandra.username	Cassandra db username	""
connector_main.cassandra.local_datacenter	Name of cassandra datacenter	""
connector_main.secret.name	Name of the secret for vulnerable data	connector-main-secret
connector_main.secret.cassandra_password	Cassandra db password	"password"
connector_main.secret.datasource_password	H2 db password	"password"
connector_main.datasource.url	H2 database url	""
connector_main.datasource.username	H2 database username	""
connector_main.datasource.console.enabled	Enable console for H2	true
connector_main.zookeeper.host	Host at which ZooKeeper is running	127.0.0.1
connector_main.zookeeper.port	Port at which ZooKeeper is running	2181
connector_main.zookeeper.range.limit	The range limit upto which a value is allotted to the service by ZooKeeper	1000000
connector_main.zookeeper.znode.path.counter	The Znode path at which counter is stored	"/counter"
connector_main.livenessProbe.enabled	Enable livenessProbe	true
connector_main.livenessProbe.initialDelaySeconds	Initial delay seconds for livenessProbe	5
connector_main.livenessProbe.periodSeconds	Period seconds for livenessProbe	5
connector_main.readinessProbe.enabled	Enable readinessProbe	true
connector_main.readinessProbe.initialDelaySeconds	Initial delay seconds for readinessProbe	5
connector_main.readinessProbe.periodSeconds	Period seconds for readinessProbe	5

Contributing

DISCLAIMER: Make sure not to force push untill unavoidable.

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -m 'Add some feature')
4. Clear the checks and make sure build is successfull
5. Push your branch (git push origin my-new-feature)
6. Create a new Pull Request.