diff --git a/README.md b/README.md index 58686607bcba9ab2874436078a2321943c4c6553..e90997796fb509629e579fda631a4a5e180eb937 100644 --- a/README.md +++ b/README.md @@ -21,27 +21,13 @@ [NMaaS Janitor](https://github.com/nmaas-platform/nmaas-janitor) is a microservice that interacts with GitLab and Kubernetes API to perform various low level operations on behalf of the NMaaS Platform -### Technologies - - -* [Go](https://go.dev/) -* [Protobuf](https://protobuf.dev/) -* [gRPC](https://grpc.io/) -* [kubernetes/client-go](https://github.com/kubernetes/client-go) -* [go-gitlab](https://pkg.go.dev/github.com/xanzy/go-gitlab) - ### Features -* Creating deployment ConfigMap(s) when configuration is pushed to GitLab repository -* Updating deployment ConfigMap(s) on demand -* Verifying deployment or statefulset status on demand -* Setting basic auth parameters on Ingress resources on demand -* Retrieving loadbalancer IP address assigned to given deployment or statefulset - -### Deploying - -The provided Dockerfile comprises a two-stage Docker image build. -You don't have to compile protoc yourself, nor configure local golang environment. Just run `docker build`, and image will do all the work for you. +- Creating deployment ConfigMap(s) when configuration is pushed to GitLab repository +- Updating deployment ConfigMap(s) on demand +- Verifying deployment or statefulset status on demand +- Setting basic auth parameters on Ingress resources on demand +- Retrieving loadbalancer IP address assigned to given deployment or statefulset ### Get in Touch diff --git a/docs/DEVELOPMENT.md b/docs/DEVELOPMENT.md new file mode 100644 index 0000000000000000000000000000000000000000..6e58850e0be198316da5039353afd3c2be130c0c --- /dev/null +++ b/docs/DEVELOPMENT.md @@ -0,0 +1,14 @@ +# NMaaS Janitor + +### Technologies + +* [Go](https://go.dev/) +* [Protobuf](https://protobuf.dev/) +* [gRPC](https://grpc.io/) +* [kubernetes/client-go](https://github.com/kubernetes/client-go) +* [go-gitlab](https://pkg.go.dev/github.com/xanzy/go-gitlab) + +### Deploying + +The provided Dockerfile comprises a two-stage Docker image build. +You don't have to compile protoc yourself, nor configure local golang environment. Just run `docker build`, and image will do all the work for you. \ No newline at end of file diff --git a/docs/nmaas-logo-blue.png b/docs/nmaas-logo-blue.png new file mode 100644 index 0000000000000000000000000000000000000000..2ab81d686b5da7b544f7f93da742ab393ac50fa4 Binary files /dev/null and b/docs/nmaas-logo-blue.png differ diff --git a/docs/nmaas-logo-white.png b/docs/nmaas-logo-white.png new file mode 100644 index 0000000000000000000000000000000000000000..3226b4d55678026b0e8ee044d2f3a8c9f5f9745b Binary files /dev/null and b/docs/nmaas-logo-white.png differ