diff --git a/README.md b/README.md index 400aa5670a69a9fe4e5f50f3b0d314b8b3c1feb3..58686607bcba9ab2874436078a2321943c4c6553 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,34 @@ -# NMaaS Janitor (back-end) +<div align="center"> + <a href="https://docs.nmaas.eu/"> + <img src="docs/nmaas-logo-blue.png" alt="Logo" width="206" height="48"> + </a> -#### NMaaS Janitor is a microservice that interacts with GitLab and Kubernetes API to perform various low level operations on behalf of the NMaaS Platform +<h3 align="center">NMaaS Janitor (back-end)</h3> + +<h4 align="center">Open-source multi-tenant platform for effortless, orchestrated deployment of software tools and applications on top of Kubernetes</h4> + + <p align="center"> + <br /> + <a href="https://docs.nmaas.eu/">Explore documentation</a> + · + <a href="https://github.com/nmaas-platform/nmaas-janitor/issues">Report Bug</a> + · + <a href="https://github.com/nmaas-platform/nmaas-janitor/issues">Request Feature</a> + </p> +</div> + +## NNMaaS Janitor + +[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 -* Protobuf -* gRPC -* kubernetes/client-go -* go-gitlab + +* [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 @@ -20,5 +40,13 @@ ### 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 +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. + +### Get in Touch + +Interested users can use the following mailing lists to subscribe to news about NMaaS, get in touch with the NMaaS development team, or other NMaaS users: + +- [nmaas-announce@lists.geant.org](mailto:nmaas-announce@lists.geant.org) - public mailing list for announcements shared by the NMaaS team with the community ([subscribe here](https://lists.geant.org/sympa/info/nmaas-announce)) +- [nmaas@lists.geant.org](mailto:nmaas@lists.geant.org) - private mailing list for contacting the NMaaS core team members +- [nmaas-users@lists.geant.org](mailto:nmaas-users@lists.geant.org) - public mailing lists for discussions related to NMaaS usage and development ([subscribe here](https://lists.geant.org/sympa/info/nmaas-users))