kops/docs

Documentation Index

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

Quick start

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

Overview

• 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

• 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

API / Configuration References

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

API Usage Guides

• 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

• 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 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

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

kops design documents

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

Security

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

Inspection

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

Development

• 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 Gossip design
• Notes on master instance sizing
• Our release process
• Releasing with Homebrew
• Rolling Update Diagrams