search

kubernetes-sigs / cluster-api-provider-aws

Kubernetes Cluster API Provider AWS provides consistent deployment and day 2 operations of "self-managed" and EKS Kubernetes clusters on AWS.
http://cluster-api-aws.sigs.k8s.io/
Apache License 2.0
631 stars 551 forks source link

EPIC: Production-level documentation #2268

Open randomvariable opened 3 years ago

randomvariable commented 3 years ago

/kind documentation /help

I've been going through documents for AWS Technical Baseline Reviews, and have drawn up this list of documentation that we should have to help end-users based on their checklist.

k8s-ci-robot commented 3 years ago

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

Please ensure the request meets the requirements listed here.

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

In response to [this](https://github.com/kubernetes-sigs/cluster-api-provider-aws/issues/2268): >/kind documentation >/help > >I've been going through documents for [AWS Technical Baseline Reviews](https://aws.amazon.com/partners/foundational-technical-review/), and have drawn up this list of documentation that we should have to help end-users based on their checklist. > >- [ ] Typical deployment with list of all resources >- [ ] List all deployment options (single-AZ, multi-AZ, multi-region) >- [ ] Expected time to complete deployment >- [ ] List skills / knowledge to complete deployment (familiarity with AWS, specific services etc...) >- [ ] Supported environment configurations (networking, DNS etc...) >- [ ] Architecture diagram using AWS simple icons, labelling where user data is stored >- [ ] Network diagram showing VPCs, subnets, security groups, NACLs, and ingress/egress mappings >- [ ] Integration points showing third-party assets (e.g. Kubernetes OCI registries) >- [ ] Links to IAM and IAM best practice documentation >- [ ] How to deploy without root privileges >- [ ] Prescriptive guidance on least privilege policies >- [ ] Clearly highlight public resources (like AMIs, clusterctl Github repos) >- [ ] Describe purpose and location of each key (EBS root volume encryption etc....) >- [ ] Document maintenance of AWS Secrets Manager >- [ ] Highight where sensitive data is stored (PVCs and etcd root volumes) >- [ ] List of all billable services, showing which are mandatory or optional >- [ ] Guidance for EC2 instance type and size selection >- [ ] Guidance for EBS volume type and size selection >- [X] Step by step instructions for typical deployment > architecture >- [ ] Step-by-step deployment guide for maximising uptime and reliability >- [ ] Prescriptive guidance for testing and troubleshooting >- [ ] Step-by-step Instruitions on how to assess and monitor the health of the cluster and Cluster API >- [ ] Step-by-step instructions for restoring data from a backup >- [ ] Step-by-step instructions for recovery from instance failure >- [ ] Step-by-step instructions for recovery from AZ failure >- [ ] Documentation on managing AWS & K8s service limits to allow for disaster recovery >- [ ] Documented RTO and RPOs for deployments >- [ ] Step-by-step instructions for rotating credentials and cryptographic keys >- [ ] Prescriptive guidance for software patches and upgrades >- [ ] Prescriptive guidance for managing AWS service limits >- [ ] Step-by-step instructions on handling fault conditions >- [ ] Step-by-step instructions for recovery >- [ ] How to use externally provisioned ASGs via third-party services for both unmanaged and EKS >- [ ] How to run "airgapped" >- [ ] How to bootstrap with temporary credentials >- [ ] Diagnosing CloudFormation errors > Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.
richardcase commented 3 years ago

Great list @randomvariable. I can help with some of this.

sftim commented 3 years ago

Architecture diagram using AWS simple icons, labelling where user data is stored

For my part I'd also be OK with using eg https://github.com/kubernetes/community/tree/master/icons

k8s-triage-robot commented 2 years ago

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:

You can:

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

/lifecycle stale

richardcase commented 2 years ago

/lifecycle frozen

randomvariable commented 2 years ago

@sfzylad , let's chat about this at some point too.

randomvariable commented 2 years ago

/priority important-longterm

richardcase commented 2 years ago

/remove-lifecycle frozen

k8s-triage-robot commented 1 year ago

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:

You can:

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

/lifecycle stale

k8s-triage-robot commented 1 year ago

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:

You can:

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

/lifecycle rotten