Skip to content

Latest commit

 

History

History
53 lines (36 loc) · 1.97 KB

custom-resource.md

File metadata and controls

53 lines (36 loc) · 1.97 KB
Raw
title
CRD kind

The {CRD name} CustomResourceDefinition (CRD) is a detailed description of the kind of data and the format used to {provide the CRD description}. To get the up-to-date CRD and show the output in the yaml format, run this command:

kubectl get crd {CRD name} -o yaml

Sample Custom Resource

This is a sample resource that {provide a description of what the example presents}.

apiVersion:
kind:
metadata:
  name:
{another_field}:

Custom Resource Parameters

This table lists all the possible parameters of a given resource together with their descriptions:

Parameter Required Description
metadata.name Yes Specifies the name of the CR.
{another_parameter} {Yes/No} {Parameter description}

Related Resources and Components

These are the resources related to this CR:

Custom resource Description
{Related CRD kind} {Briefly describe the relation between the resources}.

These components use this CR:

Component Description
{Component name} {Briefly describe the relation between the CR and the given component}.