diff --git a/docs/.gitkeep b/docs/.gitkeep new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000000000000000000000000000000000000..1ba7c26ac8c2c475e70dfb1a997ba04ba14e5da1 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,60 @@ +# Minio Operator + +Project [here](https://github.com/minio/minio-operator). + +MinIO is a high performance, distributed object storage system. It is software-defined, runs on industry standard hardware and is 100% open source under the Apache V2 license. + +App Version: Operator 1.0.7, instance 1.0.7 +Plugins: +Additional docs for using and its plugins can be found at $URL +The containers being used are maintained in the public/apps/minio registry. These containers ahve not been hardened, but have been retagged. When available hardened containers will be implemented. + +secrets=minio-creds-secret + +Usage + +Prerequisites + +Kubernetes cluster deployed +Kubernetes config installed in ~/.kube/config + + + + +Install kubectl +brew install kubectl +Install kustomize +brew install kustomize + +Deployment +Clone repository +git clone https://repo1.dsop.io/platform-one/apps/fluentd-elasticsearch.git +cd fluentd-elasticsearch +Apply kustomized manifest +kubectl -k ./ + +Operations +By default, this application will use an index prefix name of logstash. To verify and configure the +index, utilize Kibana Discover. +The Fluentd inputs and outputs are defined in the ConfigMap resource, which sources from the conf files. + +Container Environment Variables +These variables are patched in via kustomize and may require modifications depending on your +environment. + + + + + + +Contributing +Clone repository +git clone https://repo1.dsop.io/platform-one/apps/fluentd-elasticsearch.git +Create a feature branch +git checkout -b +Stage and commit changes +git add . +git commit -m "Made a change for reasons" +Push commits to upstream branch +git push -u origin +Create a new merge request