Commit 4f2a5122 authored by Prout, Ryan's avatar Prout, Ryan
Browse files

update readme

parent 732d0bf4
Loading
Loading
Loading
Loading
+10 −46
Original line number Diff line number Diff line
@@ -4,64 +4,28 @@ This Chart provides an example that deploys a standalone [MinIO](https://min.io/

This example is a derivative of the [MinIO provided example](https://github.com/minio/minio/blob/master/docs/orchestration/kubernetes/k8s-yaml.md) to target Slate specifically.

Feel free to look at the individual [template files](./templates), in this minio-standalone chart, to gain basic familiarity with the application/chart building blocks.
Feel free to look at the individual [template files](./templates), in this minio-standalone chart, to gain basic familiarity with the application/chart building blocks. The details of these file is covered below.

**NOTE:** The main objective of this example is to show how the smaller, individual core, components come together to create a simple application deployment. This example can be used to build off of, for a variety of data applications, but it is not meant to be a production deployment. A production deployment may require more thought and robust configurations.
**NOTE:** The main objective of this example is to show how the smaller, individual core, components come together to create a simple application deployment. This example can be used to build off of, for a variety of data applications, but it is not necessarily meant to be a production deployment. A production deployment may require more thought and robust configurations.

## Prerequisites
## Prerequisites to use this chart

To install this chart on Slate's Marble cluster it is assumed you have the following:
Please follow the Slate user docs to use this Chart on Marble (link will be provided soon).

- A Slate project allocation
- The OC tool is intalled locally
- Ability to log into Slate's Marble cluster via the OC CLI
- Helm version 3 is installed locally
- The access key and secret key, for the MinIO application, are installed via a secret-token.yaml of your own (not provided in this chart).
## Core Components of the MinIO Standalone Server on Slate

Example secret-token.yaml file:
This section describes the building blocks of the standalone MinIO server chart.

```
apiVersion: v1
kind: List
metadata: {}
items:
- apiVersion: v1
  kind: Secret
  metadata:
    # The <name-of-your-app> piece can be found in the values.yaml file at 'minio.name'. You can set the name of your app.
    # Keep the "-access-key" part appended to the name.
    name: <name-of-your-app>-access-key
  stringData:
    SECRET_TOKEN: <your_choice>
- apiVersion: v1
  kind: Secret
  metadata:
    name: <name-of-your-app>-secret-key
  stringData:
    SECRET_TOKEN: <your_choice>
```
Replace ```<your_choice>``` with your secret token strings of choice. These are needed to log into the MinIO GUI, after the NCCS SSO page.

Once you have your secret-tokens.yaml file established, you can apply it like this (must be logged into Marble via OC CLI first):
```
oc apply -f secret-token.yaml
```
The [minio-standalone-deployment.yaml](templates/minio-standalone-deployment.yaml) file picks these secret tokens up as environment variables.

It is recommended to keep the secret-token.yaml file safe, locally, and not in a repository if unencrypted. 

## Deploying the MinIO Standalone Server on Slate

This section describes the process to deploy a standalone MinIO server on Slate. The deployment uses the [official MinIO Docker image](https://hub.docker.com/r/minio/minio/) from Docker Hub.

This example uses these core components of Kubernetes:
We use these core components of Kubernetes:

- [Pods](https://kubernetes.io/docs/concepts/workloads/pods/pod/)
- [Services](https://kubernetes.io/docs/concepts/services-networking/service/)
- [Deployments](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/)
- [Persistent Volume Claims](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims)

In the following we will look at the files of our Minio Standalone application/chart, that use the above core components.
This deployment uses the [official MinIO Docker image](https://hub.docker.com/r/minio/minio/) from Docker Hub.

In the following we will look at the files of our Minio Standalone chart, that use the above core components.

### The Persistent Volume Claim