Bitnami/charts
2
0
Fork 0
mirror of https://github.com/bitnami/charts.git synced 2026-02-10 20:07:22 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #3 from bitnami/shorter-readmes

Browse Source 
charts: make readmes more succicnt
This commit is contained in:
Sameer Naik
2016-03-16 23:23:51 +05:30
parent 972b9ad9b0 5395d7f075
commit 330d214e80
2 changed files with 18 additions and 184 deletions
Download Patch File Download Diff File Expand all files Collapse all files

84
mariadb/README.md
View File

@@ -4,45 +4,15 @@
Based on the [Bitnami MariaDB](https://github.com/bitnami/bitnami-docker-mariadb) image for docker, this Chart bootstraps a [MariaDB](https://mariadb.com/) deployment on a [Kubernetes](http://kubernetes.io) cluster using [Helm](https://helm.sh).
## TL;DR;
```bash
$ helm fetch bitnami/mariadb
$ helm generate mariadb
$ helm install mariadb
```
The above commands will deploy the MariaDB Chart to the `default` [kubernetes namespace](http://kubernetes.io/docs/user-guide/namespaces/).
## Persistence
For persistence of the MariaDB data, mount a [storage volume](http://kubernetes.io/docs/user-guide/volumes/) at the `/bitnami/mariadb/data` path of the MariaDB pod.
By default the MariaDB Chart mounts an [emptyDir](http://kubernetes.io/docs/user-guide/volumes/#emptydir) volume.
From the `emptyDir` documentation: *"An emptyDir volume is first created when a Pod is assigned to a Node, and exists as long as that Pod is running on that node... When a Pod is removed from a node for any reason, the data in the emptyDir is deleted forever."*
## Configuration
To persist your MariaDB data across Pod shutdown and startup we need to mount a persistent storage volume at `/bitnami/mariadb/data`. For the purpose of demonstration we'll use a [gcePersistentDisk](http://kubernetes.io/docs/user-guide/volumes/#gcepersistentdisk).
Create a GCE PD using:
```bash
$ gcloud compute disks create --size=500GB --zone=us-central1-a mariadb-data-disk
```
> Note: You will be charged additionally for this volume.
## Deploying the Chart
### Step 1. Fetch the MariaDB Chart to your workspace
```bash
$ helm fetch bitnami/mariadb
```
The MariaDB Chart will be copied into your workspace, located at `~/.helm/workspace/charts/mariadb/`
### Step 2. Edit the default MariaDB configuration
To edit the default Redmine configuration, run
```bash
$ helm edit mariadb
@@ -52,64 +22,16 @@ By default the MariaDB root password is not assigned a value. Edit the value of
> Tip: If you have issues running the above command, add `se autochdir` to your `~/.vimrc` profile or simply edit `~/.helm/workspace/charts/mariadb/tpl/values.toml` in your favourite editor.
If you [setup a GCE PD](#Persistence), you will need to update the `mariadb/tpl/mariadb-controller.yaml` as well.
Replace:
```yaml
volumes:
- name: data
emptyDir: {}
```
with
```yaml
volumes:
- name: data
gcePersistentDisk:
pdName: mariadb-data-disk
fsType: ext4
```
### Step 3. Generate the Chart
Finally, generate the chart to apply your changes to the configuration.
```bash
$ helm generate mariadb
```
The above command will generate the MariaDB Chart with your changes from the last step.
### Step 4. Deploy MariaDB
```bash
$ helm install mariadb
```
In the above command, Helm will deploy the MariaDB Chart in the cluster in the `default` namespace.
The deployment status of the MariaDB pods can be checked with `kubectl` using:
```bash
$ kubectl get pods -l provider=mariadb
NAME READY STATUS RESTARTS AGE
mariadb-3fu51 1/1 Running 0 1m
```
Your MariaDB deployment is now ready to be used.
## Cleanup
To delete the MariaDB deployment completely:
### Step 1. Uninstall the MariaDB Chart:
```bash
$ helm uninstall -n default mariadb
```
### Step 2. Delete the persistent disk:
```bash
$ gcloud compute disks delete mariadb-data-disk
```

118
redmine/README.md
View File

@@ -4,31 +4,6 @@
Based on the [Bitnami Redmine](https://github.com/bitnami/bitnami-docker-redmine) image for docker, this Chart bootstraps a [Redmine](https://redmine.org/) deployment on a [Kubernetes](https://kubernetes.io) cluster using [Helm](https://helm.sh).
## TL;DR;
### Step 1. Deploy MariaDB Chart
```bash
$ helm fetch bitnami/mariadb
$ helm generate mariadb
$ helm install mariadb
```
### Step 2. Deploy Redmine Chart
```bash
$ helm fetch bitnami/redmine
$ helm generate redmine
$ helm install redmine
```
The above commands will deploy the MariaDB and Redmine Charts to the `default` kubernetes namespace.
Get the external IP address of your Redmine instance and login using the default credentials:
- Username: `user`
- Password: `bitnami`
## Dependencies
The Redmine Chart requires the [Bitnami MariaDB Chart](https://github.com/bitnami/charts/tree/master/mariadb) for setting up a database backend.
@@ -43,31 +18,9 @@ For persistence of the Redmine configuration and user file uploads, mount a [sto
By default the Redmine Chart mounts an [emptyDir](http://kubernetes.io/docs/user-guide/volumes/#emptydir) volume.
From the `emptyDir` documentation: *"An emptyDir volume is first created when a Pod is assigned to a Node, and exists as long as that Pod is running on that node... When a Pod is removed from a node for any reason, the data in the emptyDir is deleted forever."*
## Configuration
To persist your Redmine data across Pod shutdown and startup we need to mount a persistent storage volume at `/bitnami/redmine`. For the purpose of demonstration we'll use a [gcePersistentDisk](http://kubernetes.io/docs/user-guide/volumes/#gcepersistentdisk).
Create a GCE PD using:
```bash
$ gcloud compute disks create --size=500GB --zone=us-central1-a redmine-data-disk
```
> Note: You will be charged additionally for this volume.
## Deploying the Chart
Once you have MariaDB deployed and optionally created a persistent storage disk for Redmine, we are ready to deploy the Bitnami Redmine Chart.
### Step 1. Fetch the Redmine Chart to your workspace
```bash
$ helm fetch bitnami/redmine
```
The Redmine Chart will be copied into your workspace, located at `~/.helm/workspace/charts/redmine/`
### Step 2. Edit the default Redmine configuration
To edit the default Redmine configuration, run
```bash
$ helm edit redmine
@@ -83,61 +36,23 @@ The values of `redmineUser` and `redminePassword` are the login credentials when
>
> If you had updated the MariaDB root password for the MariaDB deployment, then ensure you set the same password for the `mariadbPassword` field in the Redmine Chart.
If you had [setup a GCE PD](#Persistence), you will need to update the `tpl/mariadb-controller.yaml` as well.
Replace:
```yaml
volumes:
- name: data
emptyDir: {}
```
with
```yaml
volumes:
- name: data
gcePersistentDisk:
pdName: redmine-data-disk
fsType: ext4
```
### Step 3. Generate the Chart
Finally, generate the chart to apply your changes to the configuration.
```bash
$ helm generate redmine
```
The above command will generate the Redmine Chart with your changes from the last step.
### Step 4. Deploy Redmine
```bash
$ helm install redmine
```
In the above command, Helm will deploy the Redmine Chart in the cluster in the `default` namespace.
> Note:
>
> On GKE, the above command will automatically configure a firewall rule so that the Redmine instance is accessible from the internet, for which you will be charged additionally.
>
> On other cloud platforms you may have to setup a firewall rule manually. Please refer your cloud providers documentation.
The deployment status of the Redmine pods can be checked with `kubectl` using:
```bash
$ kubectl get pods -l app=redmine,provider=redmine-server
NAME READY STATUS RESTARTS AGE
redmine-b3jld 1/1 Running 0 1m
```
## Access your Redmine application
You should now be able to access the application using the external IP configured for the Redmine service.
In the case of GKE, get the external IP address of your Redmine instance using:
> Note:
>
> On GKE, the service will automatically configure a firewall rule so that the Redmine instance is accessible from the internet, for which you will be charged additionally.
>
> On other cloud platforms you may have to setup a firewall rule manually. Please refer your cloud providers documentation.
Get the external IP address of your Redmine instance using:
```bash
$ kubectl get services redmine
@@ -147,20 +62,17 @@ redmine 10.99.240.185 104.197.156.125 80/TCP app=redmine 3m
Access your Redmine deployment using the IP address listed under the `EXTERNAL_IP` column.
The default credentials are:
- Username: `user`
- Password: `bitnami`
## Cleanup
To delete the Redmine deployment completely:
### Step 1. Uninstall the Redmine Chart:
```bash
$ helm uninstall -n default redmine
```
### Step 2. Delete the persistent disk:
```bash
$ gcloud compute disks delete redmine-data-disk
```
Additionally you may want to [Cleanup the MariaDB Chart](https://github.com/bitnami/charts/tree/master/mariadb#cleanup)