Kubernetes

For Our reading

Teams running containerized applications in production, from local testing to global enterprises, and the platform builders who extend it (paraphrase of homepage and overview).

Problem Published

Containers in production must be managed so nothing goes down: when one fails, another must start (paraphrase).

Promise Published

A framework to run distributed systems resiliently: scaling, failover and deployment patterns handled for you (paraphrase).

Stated job Our reading

Automate deployment, scaling and management of containerized applications (paraphrase of the homepage definition; no mission statement is published).

Proof behind each pillar

• Planet scale. Builds on 15 years of Google's experience running production workloads.
• Planet scale. Google runs billions of containers a week on the same principles.
• Never outgrow. Self-healing, automated rollouts and rollbacks, service discovery, storage orchestration, bin packing, horizontal scaling, IPv4/IPv6 dual-stack, extensibility.
• Run K8s anywhere. A CNCF graduated project.
• Run K8s anywhere. Google open sourced the project in 2014.

Story Published

The name is Greek for helmsman or pilot, which is why the mark is a ship's wheel. Google open sourced Kubernetes in 2014 on 15 years of running production workloads (Borg); it is now a graduated CNCF project under the Linux Foundation, written and maintained by the Kubernetes Authors and its SIGs.

Category. Container orchestration Published

Why them

1. Open source and vendor-neutral, governed in the open under the CNCF. Published
2. Runs anywhere: on-premises, hybrid or public cloud. Published
3. Extensible without changing upstream code. Published
4. Google-scale lineage: 15 years of production experience. Published

Instead of

Traditional all-inclusive PaaS systems (the overview names what Kubernetes is not).

Boilerplate Published

Kubernetes, also known as K8s, is an open source system that automates deploying, scaling and managing containerized applications. It groups an application's containers into logical units for management and discovery, and builds on 15 years of running production workloads at Google plus the community's best ideas.

Taglines

They never claim

• Not a traditional, all-inclusive PaaS: it gives building blocks and keeps logging, monitoring and CI/CD optional and pluggable (paraphrase). Published
• Nothing may imply that the Linux Foundation or Kubernetes sponsors or endorses a product. Published

The homepage carries the messaging: one title (Production-Grade Container Orchestration), a definition sentence, and three short feature heads (Planet scale, Never outgrow, Run K8s anywhere). No messaging framework is published.

Source: kubernetes.iokubernetes.io/docs/concepts/overview

• American spelling
• Sentence case headlines
• Address the reader as "you"; avoid "we" (the reader can't tell if they're included)
• Present tense ("This command starts a proxy"), unless the meaning needs another
• Active voice, unless it makes the sentence awkward
• Simple, direct language: "To create", not "In order to create"; no "please"
• Say “for example / that is”, not “e.g.” or “i.e.”
• Say “internally / create”, not “under the hood” or “turn up”
• Never: just, simply, easy, easily, simple
• Never: currently, new. Say a version number ("In version 1.4")
• No promises or hints about the future, except announced deprecations
• Say “K8s”, not “K8S” or “K8”
• Say “cloud native”, not “cloud-native” or “Cloud Native”
• Say “open source”, not “open-source” or “Open Source”
• Say “on-premises / on-prem”, not “on-premise”
• Kubernetes is always capitalized (a proper noun)
• API kinds in UpperCamelCase, never split and never in code style (a ConfigMap, a PodTemplateList)
• Code style for commands, tools, components, fields, files and paths (`kubectl`, `replicas`, `kube-system`)
• Bold for UI elements; italics to introduce a new term
• Punctuation outside quotes (international standard)
• Link text that says where it goes; never "click here"
• Paragraphs under six sentences
• Use the mark as an adjective with a generic noun, never plural or possessive
• Third parties say "<product> for Kubernetes" or "compatible with Kubernetes", never "Kubernetes <product>"

DirectPreciseNeutralInclusive

The published voice is SIG Docs' documentation style guide: US English, you not we, present tense, active voice, no idioms, no Latin abbreviations, no words that assume ease, no dated words. CNCF adds the naming rules (K8s, cloud native, open source).

• Address the reader as you; the project, not we, does things
• Present tense, active voice, simple direct verbs
• Sentence case for body headings; title case for page titles
• UpperCamelCase API kinds; code style for commands, tools and fields
• Keep paragraphs under six sentences
• Use a version number instead of current or new

• Kubernetes' published voice is a documentation voice: SIG Docs' style guide, which calls itself guidelines, not rules.
• Write for a reader who may speak English as a second language: no idioms, no Latin, no 'just' or 'simply'.
• Vendor-neutral: the project speaks as itself ('Kubernetes provides...'), not as a company ('we provide...').
• Precision is the voice: API kinds in UpperCamelCase, code in code style, values in plain text.
• The homepage copy is older and looser than the style guide (it uses 'easily' and 'effortlessly'); new copy follows the guide.

Source: kubernetes.io/docs/contribute/style/style-guidegithub.com/cncf/foundation/blob/main/style-guide.mdlinuxfoundation.org/legal/trademark-usage

Source: kubernetes.io/docs/contribute/style/style-guidekubernetes.io/docs/contribute/style/content-guidegithub.com/cncf/foundation/blob/main/style-guide.md

The logo is a white ship's wheel in a Kubernetes Blue heptagon, plus the lowercase wordmark kubernetes. CNCF ships it in 3 layouts (horizontal, stacked, icon) and 5 versions (color, black, white, all blue, white text) as PNG and SVG: 26 unique files. In the full-color file the wordmark is black; all blue makes it blue; white text makes it white for dark grounds.

Not published: clear space; minimum size; placement.

Source: github.com/kubernetes/kubernetes/blob/master/logo/usage_guidelines.mdgithub.com/cncf/artwork/tree/main/projects/kubernetesgithub.com/kubernetes/kubernetes/blob/master/logo/LICENSElinuxfoundation.org/legal/trademark-usage

One official color: Kubernetes Blue, #326CE5 on screen and Pantone 285 C in print. Everything else on kubernetes.io is the website's: white pages, #212529 text, Bootstrap greys, light-blue feature cards #DAEAF9, a navy announcement band, dark bands and footer.

Not published: secondary palette; tints; CMYK; proportions; text and background pairings.

Source: github.com/kubernetes/kubernetes/blob/master/logo/colors.mdgithub.com/kubernetes/website/tree/main/assets/scss

No typeface is published. kubernetes.io sets everything in Open Sans (Docsy's default, from Google Fonts at 300/400/700) with a system fallback stack, and code in the system monospace stack.

Not published: typefaces; type scale; weights; tracking.

Source: github.com/kubernetes/website/tree/main/assets/scsskubernetes.io

The helm and its heptagon recur as the only graphic element: the nav logo, the favicon, the KubeCon mark and the small helm above Kubernetes Features. Dark bands carry a faint network-node texture image.

Not published: patterns; textures; grids.

Source: github.com/cncf/artwork/tree/main/projects/kuberneteskubernetes.io

No icon set is published. The site uses Font Awesome 6 (free and brands) for UI and social icons.

Not published: icon style; grid; stroke.

Source: kubernetes.io

Homepage illustrations are flat, geometric SVGs in blue #316CE6 and teal #09C1D1 with pale-teal tints: containers as squares feeding the helm (flower), a four-way scaling diamond, a growing block grid, a hexagon-patterned suitcase.

Not published: illustration guidelines.

Source: kubernetes.io

Not published. The homepage shows one video still (a KubeCon talk) and no other photography.

Not published: photography style.

Source: kubernetes.io