Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 54 additions & 0 deletions modules/adding-yaml-examples-to-kube-resources.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
// Module included in the following assemblies:
//
// * web-console/customizing-the-web-console.adoc

[id="adding-yaml-examples-to-kube-resources_{context}"]
= Adding YAML examples to Kubernetes resources

You can dynamically add YAML examples to any Kubernetes resources at any time.

. Prerequisites

* You must have cluster administrator privileges.

.Procedure

. From *Administration* -> *Custom Resource Definitions*, click on *ConsoleYAMLSample*.

. Click *YAML* and edit the file:
+
----
apiVersion: console.openshift.io/v1
kind: ConsoleYAMLSample
metadata:
name: example
spec:
targetResource:
apiVersion: batch/v1
kind: Job
title: Example Job
description: An example Job YAML sample
yaml: |
apiVersion: batch/v1
kind: Job
metadata:
name: countdown
spec:
template:
metadata:
name: countdown
spec:
containers:
- name: counter
image: centos:7
command:
- "bin/bash"
- "-c"
- "for i in 9 8 7 6 5 4 3 2 1 ; do echo $i ; done"
restartPolicy: Never
----
Use `spec.snippet` to indicate that the YAML sample is not the full YAML resource
definition, but a fragment that can be inserted into the existing YAML document
at the user's cursor.

. Click *Save*.
2 changes: 2 additions & 0 deletions web-console/customizing-the-web-console.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,5 @@ include::modules/defining-template-for-external-log-link.adoc[leveloffset=+1]
include::modules/adding-custom-notification-banners.adoc[leveloffset=+1]

include::modules/customizing-cli-downloads.adoc[leveloffset=+1]

include::modules/adding-yaml-examples-to-kube-resources.adoc[leveloffset=+1]