kops Documentation

1. Project Overview & Quickstart (kubernetes/kops) Copy Chapter

File: README.md Copy Chapter

kOps - Kubernetes Operations

The easiest way to get a production grade Kubernetes cluster up and running.

What is kOps? Copy Chapter

We like to think of it as kubectl for clusters.

kops will not only help you create, destroy, upgrade and maintain production-grade, highly
available, Kubernetes cluster, but it will also provision the necessary cloud infrastructure.

AWS (Amazon Web Services) and GCP (Google Cloud Platform) are currently officially supported, with DigitalOcean, Hetzner and OpenStack in beta support, and Azure in alpha.

Can I see it in action? Copy Chapter

Installing and launching a Kubernetes cluster hosted on AWS, GCE, DigitalOcean, Hetzner, OpenStack, Azure Copy Chapter

See Getting Started

Documentation Copy Chapter

Documentation is in the /docs directory, and can be seen at kops.sigs.k8s.io.

Releases and kubernetes Release Compatibility Copy Chapter

See Releases and versioning

Getting Involved and Contributing Copy Chapter

See Contributing

Office Hours Copy Section

kOps maintainers set aside one hour every other week for public office hours. This time is used to gather with community members interested in kOps. This session is open to both developers and users.

We do maintain an agenda and stick to it as much as possible. If you want to hold the floor, put your item in this doc. Bullet/note form is fine. Even if your topic gets in late, we do our best to cover it.

For more information about the office hours and how to join, see Office Hours

File: docs/index.md Copy Chapter

kOps - Kubernetes Operations

The easiest way to get a production grade Kubernetes cluster up and running.

What is kOps? Copy Chapter

We like to think of it as kubectl for clusters.

kops will not only help you create, destroy, upgrade and maintain production-grade, highly
available, Kubernetes cluster, but it will also provision the necessary cloud infrastructure.

AWS (Amazon Web Services) and GCE (Google Cloud Platform) are currently officially supported, with DigitalOcean, Hetzner and OpenStack in beta support, and Azure in alpha.

Can I see it in action? Copy Chapter

Features Copy Chapter

• Automates the provisioning of Highly Available Kubernetes clusters
• Built on a state-sync model for dry-runs and automatic idempotency
• Ability to generate Terraform
• Supports zero-config managed kubernetes add-ons
• Command line autocompletion
• YAML Manifest Based API Configuration
• Templating and dry-run modes for creating Manifests
• Choose from most popular CNI Networking providers out-of-the-box
• Multi-architecture ready with ARM64 support
• Capability to add containers, as hooks, and files to nodes via a cluster manifest

File: docs/README.md Copy Chapter

Documentation Index

For a better viewing experience please check out our live documentation site at kops.sigs.k8s.io.

Quick start Copy Chapter

• Getting started on AWS
• Getting started on GCE
• CLI reference

Overview Copy Chapter

• Documentation Index
  • Quick start
  • Overview
  • Command-line interface
  • Advanced / Detailed List of Configurations
    • API / Configuration References
    • API Usage Guides
  • Operations
  • Networking
  • kops design documents
  • Security
  • Inspection
  • Development

Command-line interface Copy Chapter

• CLI argument explanations
• CLI reference
• Commands
  • miscellaneous CLI-related remarks
• Experimental features
  • list of and how to enable experimental flags in the CLI
• kubectl
  • how to point kubectl to your kops cluster

Advanced / Detailed List of Configurations Copy Chapter

API / Configuration References Copy Section

• Godocs for Cluster - ClusterSpec.
• Godocs for Instance Group - InstanceGroupSpec.

API Usage Guides Copy Section

• kops cluster API definitions
  • overview of some of the API value to customize a kops cluster
• kops instance groups API
  • overview of some of the API value to customize a kops groups of k8s nodes
• Using Manifests and Customizing via the API

Operations Copy Chapter

• Cluster addon manager
• Cluster addons
• Cluster configuration management
• Cluster desired configuration creation from template
• etcd volume encryption setup
• etcd backup/restore
• GPU setup
• High Availability
• InstanceGroup Images
  • how to use other image for cluster nodes, and information on available/tested images
• k8s upgrading
• kops updating
• Label management
  • for cluster nodes
• Service Account Issuer (SAI) migration
• Service Account Token Volume Projection
• Moving from a Single Master to Multiple HA Masters
• Upgrading Kubernetes
• Working with Instance Groups
• Running kops in a CI environment

Networking Copy Chapter

• Networking Overview including CNI
• Run kops in an existing VPC
• Supported network topologies
• Subdomain setup

`kops` design documents Copy Chapter

• kops cluster boot sequence
• kops philosophy
• kops state store

Security Copy Chapter

• Bastion setup
• Instance IAM roles
• MFA setup
  • how to set up MFA for kops
• Security
  • overview of secret storage, SSH credentials etc.

Inspection Copy Chapter

• Download kops configuration
  • methods to download the current generated kops configuration
• Get AWS subdomain NS records

Development Copy Chapter

• Developing using Docker
• Documentation Guidelines
• E2E testing with kops clusters
• Example on how to add a feature
• Hack Directory
• How to update kops API
• Low level description on how kops works
• Notes on master instance sizing
• Our release process
• Releasing with Homebrew
• Rolling Updates

2. Official Technical Reference & Guides (kubernetes/kubernetes.github.io) Copy Chapter

The Kubernetes documentation

This repository contains the assets required to build the Kubernetes website and documentation. We're glad that you want to contribute!

• Contributing to the docs
• Localization READMEs

Using this repository Copy Chapter

You can run the website locally using Hugo (Extended version), or you can run it in a container runtime. We strongly recommend using the container runtime, as it gives deployment consistency with the live website.

Prerequisites Copy Chapter

To use this repository, you need the following installed locally:

• npm
• Go
• Hugo (Extended version)
• A container runtime, like Docker.

[!NOTE]
Make sure to install the Hugo extended version specified by the HUGO_VERSION environment variable in the netlify.toml file.

Before you start, install the dependencies. Clone the repository and navigate to the directory:

git clone https://github.com/kubernetes/website.git
cd website

The Kubernetes website uses the Docsy Hugo theme,
which can be installed via npm. You can also download a pre-configured
development container image that includes Hugo and Docsy. Additionally, a Git
submodule is used for tools that generate the reference documentation.

Windows Copy Section

# fetch submodule dependencies
git submodule update --init --recursive --depth 1

Linux / other Unix Copy Section

# fetch submodule dependencies
make module-init

Running the website using a container Copy Chapter

To build the site in a container, run the following:

# You can set $CONTAINER_ENGINE to the name of any Docker-like container tool

# Render the full website
make container-serve

# Render only a specific language segment (e.g., English)
make container-serve segments=en

# Render multiple languages (e.g., English and Korean)
make container-serve segments=en,ko

💡 Tip: Using Hugo segments speeds up local preview builds, by rendering only selected language(s).

If you see errors, it probably means that the Hugo container did not have enough computing resources available. To solve it, increase the amount of allowed CPU and memory usage for Docker on your machine (macOS and Windows).

Open up your browser to http://localhost:1313 to view the website. As you make changes to the source files, Hugo updates the website and forces a browser refresh.

Running the website locally using Hugo Copy Chapter

To install dependencies, deploy and test the site locally, run:

• For macOS and Linux

  bash Copy

  npm ci
  
  # Render the full site (default)
  make serve
  
  # Render only a specific language segment
  make serve segments=en
  
  # Render multiple language segments
  make serve segments=en,ko

💡 Tip: Hugo segments are defined in hugo.toml and allow faster rendering by limiting the scope to specific language(s).

• For Windows (PowerShell)

  powershell Copy

  npm ci
  hugo.exe server --config hugo.toml,hugo.server.toml --buildFuture --environment development

This will start the local Hugo server on port 1313. Open up your browser to http://localhost:1313 to view the website. As you make changes to the source files, Hugo updates the website and forces a browser refresh.

Building the API reference pages Copy Chapter

The API reference pages located in content/en/docs/reference/kubernetes-api are built from the Swagger specification, also known as OpenAPI specification, using https://github.com/kubernetes-sigs/reference-docs/tree/master/gen-resourcesdocs.

To update the reference pages for a new Kubernetes release follow these steps:

1. Pull in the api-ref-generator submodule:

   bash Copy

   git submodule update --init --recursive --depth 1

2. Update the Swagger specification:

   bash Copy

   curl 'https://raw.githubusercontent.com/kubernetes/kubernetes/master/api/openapi-spec/swagger.json' > api-ref-assets/api/swagger.json

3. In api-ref-assets/config/, adapt the files toc.yaml and fields.yaml to reflect the changes of the new release.

4. Next, build the pages:

   bash Copy

   make api-reference

   You can test the results locally by building and serving the site from a container:

   bash Copy

   make container-serve

   In a web browser, go to http://localhost:1313/docs/reference/kubernetes-api/ to view the API reference.

5. When all changes of the new contract are reflected into the configuration files toc.yaml and fields.yaml, create a Pull Request with the newly generated API reference pages.

Troubleshooting Copy Chapter

If you experience any issues with running website locally, please refer
to the Troubleshooting section of the contributing documentation.

Get involved with SIG Docs Copy Chapter

Learn more about SIG Docs Kubernetes community and meetings on the community page.

You can also reach the maintainers of this project at:

• Slack
  • Get an invite for this Slack
• Mailing List

Contributing to the docs Copy Chapter

You can click the Fork button in the upper-right area of the screen to create a copy of this repository in your GitHub account. This copy is called a fork. Make any changes you want in your fork, and when you are ready to send those changes to us, go to your fork and create a new pull request to let us know about it.

Once your pull request is created, a Kubernetes reviewer will take responsibility for providing clear, actionable feedback. As the owner of the pull request, it is your responsibility to modify your pull request to address the feedback that has been provided to you by the Kubernetes reviewer.

Also, note that you may end up having more than one Kubernetes reviewer provide you feedback or you may end up getting feedback from a Kubernetes reviewer that is different than the one initially assigned to provide you feedback.

Furthermore, in some cases, one of your reviewers might ask for a technical review from a Kubernetes tech reviewer when needed. Reviewers will do their best to provide feedback in a timely fashion but response time can vary based on circumstances.

For more information about contributing to the Kubernetes documentation, see:

• Contribute to Kubernetes docs
• Page Content Types
• Documentation Style Guide
• Localizing Kubernetes Documentation
• Introduction to Kubernetes Docs

New contributor ambassadors Copy Section

If you need help at any point when contributing, the New Contributor Ambassadors are a good point of contact. These are SIG Docs approvers whose responsibilities include mentoring new contributors and helping them through their first few pull requests. The best place to contact the New Contributors Ambassadors would be on the Kubernetes Slack. Current New Contributors Ambassadors for SIG Docs:

Localization READMEs Copy Chapter

Code of conduct Copy Chapter

Participation in the Kubernetes community is governed by the CNCF Code of Conduct.

Thank you Copy Chapter

Kubernetes thrives on community participation, and we appreciate your contributions to our website and our documentation!