Skip to content

Using UpperCamelCase for Kubernetes resources #573

Open
@jacobtomlinson

Description

@jacobtomlinson

The Kubernetes documentation style-guide encourages the use of UpperCamelCase (also known as PascalCase) when referring to Kubernetes resources.

It's a little nitpicky but I think it would be good to be consistent with this in our own documentation. For example we regularly writer pods when we should write Pods.

Examples in our docs

Now you can create `DaskCluster` resources in Kubernetes that will launch all the necessary pods and services for our cluster to work. This can be done in YAML via the Kubernetes API or using the Python API from a notebook session as shown in this section.

Note that all scheduler, worker and jupyter pods are required to use the same image.

Colocate worker pods on Kubernetes

Guidance Examples

Guidance form the style-guide

Do Don't
The HorizontalPodAutoscaler resource is responsible for ... The Horizontal pod autoscaler is responsible for ...
A PodList object is a list of pods. A Pod List object is a list of pods.
The Volume object contains a hostPath field. The volume object contains a hostPath field.
Every ConfigMap object is part of a namespace. Every configMap object is part of a namespace.
For managing confidential data, consider using the Secret API. For managing confidential data, consider using the secret API.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions