Feature: Readme/Metadata for clusters added on Devtron

[prakarsh-dt]

🔖 Feature description

Infrastructure/DevOps people have no place to maintain meta data about Clusters which are added to Devtron as of now and they have to manage a separate documentation if they want to do that. Meta data may include information such as:

• IngressClass and Ingress controller info deployed on clusters
• Nodegroups information and taints put on those nodegroups.
• Connectivity information with other VPCs/Clusters
• Security policies implemented.
• Contact info of personals responsible for managing the cluster infra.

🎤 Pitch

Example Readme file

Devtron Production Cluster

Ingress Classes available

• nginx-utils - Use for cluster utilities like grafana, kibana etc.
• nginx-pub - Use for Public LoadBalancer (NLB) SSL ACM attached *.devtron.ai
• nginx-int - Use for Internal LoadBalancer (NLB)

Node groups available

1. ci-nodes
   Taint: purpose:ci:NoSchedule
   Labels: purpose: ci
   Info: Used for running CI-workloads
   Machine type: c5n.xlarge, c5a.xlarge, r4.xlarge (100% spot nodes)
   Availability Zones: AZ-a, AZ-b, AZ-c
   ASG: Min:0 / Max:5

2. devtron-nodes
   Taint: -
   Labels: purpose:devtron-nodes
   Info: Used for Devtron microservices
   Machine type: c5a.xlarge (1 node OD rest 100% spot)
   ASG: Min:1 / Max:3

3. od-production
   Taint: purpose:prod:NoSchedule
   Labels: purpose:devtron-prod
   Info: Used for Devtron production microservices like blogs, website.
   Machine type: c5a.xlarge (1 node OD)
   ASG: Min:1 / Max:2

Networking and Connectivity

VPC peering done for: vpc-stage1234, vpc-demo1234
api-server: private and public (Public whitelisted CIDR: 19.34.56.32/32 34.45.56.10/32)

Security Policies

• Deployment of Images with Medium vulnerabilities and above are blocked.
• Deployment of apps without mandatory tags are blocked. (Mandatory tags: owner, business-unit)

Infra SPOCs

1. Prakarsh
   prakarsh@abc.com
   +1-888-000-1111

2. Pawan
   pawan@abc.com
   +1-888-111-1100

✌️ Solution

Adding a Readme section on Cluster level which gets committed to a git repo on each change to maintain change-history.

🔄️ Alternative

External links to be provided on Cluster level which can be used to point to respective configurations on the existing Readme.

👀 Have you spent some time to check if this issue has been raised before?

• I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

• I have read the Code of Conduct