devel/coding-conventions

Version 1.0
What is Kubernetes?
Getting Started
Creating Kubernetes Clusters
- Local-machine Solutions
- Hosted Solution: Google Container Engine
- Turn-key Cloud Solutions
  - GCE
  - AWS
  - Azure
- Custom Solutions
  - Getting Started from Scratch
  - Cloud:
  - AWS or GCE (CoreOS)
  - AWS or Joyent (Ubuntu)
  - Rackspace (CoreOS)
  - On-Premise VMs:
  - Vagrant or VMware
  - CloudStack
  - VMware
  - Juju
  - libvirt (CoreOS)
  - oVirt
  - libvirt or KVM
  - Bare Metal:
  - Offline
  - Fedora via Ansible
  - Fedora: Single Node
  - Fedora: Multi Node
  - Centos
  - Ubuntu
  - Docker: Multi Node
  - Integrations:
  - Kubernetes in Mesosphere
User's Guide
Overview and Concepts
- Architecture
- Pods
- Labels & Selectors
- Replication Controller
- Services
- Volumes
- Secrets
- Names
- Namespaces
- Annotations
Application Administration
Overview and Concepts
Quick Walkthrough (Basics Tutorials)
Detailed Walkthrough
- Quick Start: Launching Applications
- Configuring Containers
- Deploying Applications
- Connecting Applications
- Working with Containers
- Managing Deployments
Troubleshooting
- Web Interface
- Logging
- Monitoring
- Container Access (exec)
- Connect with Proxies
- Connect with Port Forwarding
Cluster Administration
Overview and Concepts
Planning and Designing
- Security
- Access Management
- Namespaces
Administering Clusters
- kube-apiserver Binary
- Authorization
- Authentication
- Accessing the API
- Admission Controllers
- Administrating Service Accounts
- Resource Quotas
- kube-scheduler Binary
- kube-controller-manager Binary
Administering Nodes
- kubelet Binary
- kube-proxy Binary
- DNS
- Networking
- OVS Networking
Managing Clusters
- Multiple Clusters
- High Availability Clusters
- Large Clusters
- Monitoring Clusters
- Changing Cluster Size
- Creating Clusters from Scratch
- Configuration Management: SaltStack
Troubleshooting
- Logging
Tutorials
Kubernetes Basics
- Kubernetes 101
- Kubernetes 201
Deploying Clusters
- Apache Cassandra Database
- Apache Spark
- Apache Storm
- Distributed Task Queue
- Hazelcast
- Meteor Applications
- Redis
- RethinkDB
Persistent Images
Multi-tier Applications
- Guestbook - Go Server
- GuestBook - PHP Server
- MySQL - Phabricator Server
Examples
Setup and Configuration
- Using Configuration Files
- Using Environment Variables
- Using the Downward API
- Assigning Pods to Nodes
- Resource Control:
- Sharing through Namespaces
- Networking:
- Creating Servers with Ext. IPs
- Setting Up & Configuring DNS
- Logging:
- Configuring with Visualization
- Deploying Elasticsearch
- Security:
- Deploying OpenShift Origin
- Creating and Using Secrets
- Storage Models:
- Persistent Volumes
- Ceph Volumes
- GlusterFS Volumes
- iSCSI Volumes
- NFS Volumes
- Test Loads, Health, and Status:
- Simulating Large Test Loads
- Checking if Pods are Healthy
- Exploring Pods
Updating Live Pods
API Reference
API Basics
- API Authorization
- Reaching the API
- Working with Resources
Kubernetes API Reference
- Operations
- Definitions
CLI Reference
kubectl
- kubectl api-versions
- kubectl cluster-info
- kubectl set-cluster
- kubectl set-context
- kubectl set-credentials
- kubectl config set
- kubectl config unset
- kubectl use-context
- kubectl config
- kubectl config view
- kubectl create
- kubectl delete
- kubectl describe
- kubectl exec
- kubectl expose
- kubectl get
- kubectl label
- kubectl logs
- kubectl namespace
- kubectl port-forward
- kubectl patch
- kubectl proxy
- kubectl replace
- kubectl rolling-update
- kubectl run
- kubectl scale
- kubectl stop
- kubectl version
Troubleshooting and Support
- Troubleshooting:
- Applications
- Clusters
- Wiki FAQ:
- User FAQ
- Debugging FAQ
- Services FAQ
- GitHub:
- Kubernetes Issues
- Security:
- Report a Security Vulnerability
Release Notes

This is an archived version of the documentation. View the latest version here.

Coding style advice for contributors