Commit 5b8ec428 authored by Prout, Ryan's avatar Prout, Ryan
Browse files

update README's

parent 24cb86ad

README.md

+40 −0
Original line number Diff line number Diff line
@@ -2,7 +2,47 @@ 


This repo exists to provide examples to build off of, when deploying your own applicaton on OLCF's Slate Platform.



The charts/ directory is where you will find various example application deployments, via helm charts, and their metadata. 



## Getting Started



### Prerequisites



NOTE: These examples will be done on Slate's Marble Cluster. Marble resides in OLCF's Moderate enclave, a peripheral system to Summit.



- You have a Slate project allocatiom

- You have the OC tool isntalled

- You can log into Slate's Marble cluster via the OC CLI

- You have helm3 installed



Please refer to the Slate user documentation (link coming soon) if you have any questions.



### Helm Chart directory/file structure



A [Chart](https://helm.sh/docs/topics/charts/) is organized as a collection of files inside a directory. The directory name is the name of the chart. You can see all of the example application charts in this repositories charts/ directory.



Here is the overall structure, of simple chart, using minio-standalone as an example:



charts/

|--- minio-standalone/

|    |--- templates/

|    |    |--- helpers.tpl

|    |    |--- minio-standalone-deployment.yaml

|    |    |--- minio-standalone-pvc.yaml

|    |    |--- minio-standalone-service.yaml

|    |    |--- network-policy.yaml

|    |    |--- route.yaml

|    |--- Chart.yaml

|    |--- README.md

|    |--- values.yaml

|--- anothoer-application/

|    |--- templates/

|    |    |--- deployment.yaml

|    |    |--- pvc.yaml

|    |    |--- other.yaml

|    |--- Chart.yaml

|    |--- README.md

|    |--- values.yaml



    

### How to use this repository
 
 No newline at end of file

charts/minio-standalone/README.md

+2 −1
Original line number Diff line number Diff line
@@ -9,7 +9,8 @@ This example is a derivative of the [MinIO provided example](https://github.com/ 
NOTE: This example will be done on Slate's Marble Cluster. Marble resides in OLCF's Moderate enclave, a peripheral system to Summit.



- You have a Slate project allocation

- You have the OC tool isntalled and can log into Slate (Marble or Onyx cluster) via the CLI

- You have the OC tool isntalled

- You can log into Slate's Marble cluster via the OC CLI

- You have helm3 installed



Please refer to the Slate user documentation (link coming soon) if you have any questions.