EPIC: Production level documentation

[sayantani11]

/kind documentation

Describe the solution you'd like Currently our project requires a lot of addition to the docs. I have made a list of few topics that we could add for better understanding of the project.

• [ ] Identity and Access Management (IAM) : Administer and authorize who can take action on resources https://cloud.google.com/iam/docs/overview https://cloud.google.com/resource-manager/docs/access-control-org https://cloud.google.com/iam/docs/tags-access-control
• [ ] Service Accounts: Creation of service account and IAM management https://cloud.google.com/iam/docs/service-accounts https://cloud.google.com/iam/docs/workload-identity-federation
• [ ] Persistent Disks for VMs provisioned in GCP
• [ ] API Endpoint Groups(Zonal & Internet / Internal & External) : Configure load balancer and IP https://cloud.google.com/load-balancing/docs/negs https://cloud.google.com/load-balancing/docs/load-balancing-overview https://cloud.google.com/load-balancing/docs
• [ ] Google Cloud Instance Group : MachinePool using MIGS (Requires GATES)
• [ ] VM identity: describes the available identities that be configured on GCP https://cloud.google.com/compute/docs/instances/access-overview https://cloud.google.com/compute/docs/instances/windows/generating-credentials
• [ ] Workload identity: https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity Related to the VM identity
• [x] Flannel: Using Flannel as a CNI solution
• [ ] ipV6: Creating ipV6 enabled clusters using CAPG https://cloud.google.com/compute/docs/ip-addresses/configure-ipv6-address
• [ ] Creating gpu enabled clusters with CAPG: https://cloud.google.com/dataproc/docs/concepts/compute/gpus
• [ ] Troubleshooting: Common issues Users might run on to using CAPG
• [x] Preemptible VM instances: users to reduce the costs of their compute resources https://cloud.google.com/compute/docs/instances/preemptible
• [ ] Cloud provider : To deploy a cluster using external cloud provider
• [ ] Custom private DNS zone name: DNS zone name to a custom value and availability of 8.8.8.8
• [ ] Alias IP: attach a secondary IP range from the GCPCluster subnet into the GCPMachine instance network
• [ ] SSH access: https://cloud.google.com/solutions/connecting-securely

[sayantani11]

/kind documentation /help

[k8s-ci-robot]

@sayantani11: This request has been marked as needing help from a contributor.

Guidelines

Please ensure that the issue body includes answers to the following questions:

• Why are we solving this issue?
• To address this issue, are there any code changes? If there are code changes, what needs to be done in the code and what places can the assignee treat as reference points?
• Does this issue have zero to low barrier of entry?
• How can the assignee reach out to you for help?

For more details on the requirements of such an issue, please see here and ensure that they are met.

If this request no longer meets these requirements, the label can be removed by commenting with the /remove-help command.

In response to this:

/kind documentation /help

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[BudhirajaMadhav]

Hi @sayantani11, Can I help with this?

[sayantani11]

@budhirajamadhav Yeah sure!!!! Which topic would you like to work on? Clarifying it for any future contributor

[mehabhalodiya]

@sayantani11 I would like to give it a try. Can you help me to get started?

[sayantani11]

@mehabhalodiya Yes definitely, you can pick any one of the topics you would like to work upon & try going through the links attached to get some idea about the topic. After that you can make an issue with a readme file on the following topic related to it's use on CAPG, and add the cluster-template(if any) in the template folder. For a better understanding of how it's done, you can look at the docs in CAPZ(cluster-api-provider-azure). And for any further issues you can reach out to me on Slack.

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue or PR as fresh with /remove-lifecycle stale
• Mark this issue or PR as rotten with /lifecycle rotten
• Close this issue or PR with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

[k8s-triage-robot]

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue or PR as fresh with /remove-lifecycle rotten
• Close this issue or PR with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

[k8s-triage-robot]

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Reopen this issue or PR with /reopen
• Mark this issue or PR as fresh with /remove-lifecycle rotten
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

[k8s-ci-robot]

@k8s-triage-robot: Closing this issue.

In response to this:

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Reopen this issue or PR with /reopen
• Mark this issue or PR as fresh with /remove-lifecycle rotten
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[sayantani11]

/reopen /remove-lifecycle rotten

[k8s-ci-robot]

@sayantani11: Reopened this issue.

In response to this:

/reopen /remove-lifecycle rotten

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[sayantani11]

/lifecycle frozen /help