Merge pull request #2406 from Allsimon/doc/yamlSerialization

fabric8io · Aug 19, 2020 · 13535b8 · 13535b8
2 parents 463c9d9 + 5c6ba25
commit 13535b8
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,7 @@
 
 #### Improvements
 * Fix #2331: Fixed documentation for namespaced informer for all custom types implementing `Namespaced` interface
+* Fix #2406: Add documentation for serializing resources to YAML
 
 #### Dependency Upgrade
 * Fix #2360: bump mockito-core from 3.4.0 to 3.4.2

diff --git a/doc/CHEATSHEET.md b/doc/CHEATSHEET.md
@@ -34,6 +34,7 @@ This document contains common usages of different resources using Fabric8 Kubern
   * [List Options](#list-options)
   * [Delete Options](#delete-options)
   * [Watch Options](#watch-options)
+  * [Serializing to yaml](#serializing-to-yaml)
 
 * [OpenShift Client DSL Usage](#openshift-client-dsl-usage)  
   * [Initializing OpenShift Client](#initializing-openshift-client)
@@ -2173,6 +2174,16 @@ client.pods().watch(new ListOptionsBuilder().withTimeoutSeconds(30L).build(), ne
 });
 ```
 
+#### Serializing to yaml
+Resources can be exported to a yaml String via the `SerializationUtils` class:
+```
+Pod myPod;
+
+String myPodAsYaml = SerializationUtils.dumpAsYaml(myPod);
+// Your pod might have some state that you don't really care about, to remove it:
+String myPodAsYamlWithoutRuntimeState = dumpWithoutRuntimeStateAsYaml(myPod);
+```
+
 ### OpenShift Client DSL Usage
 
 Fabric8 Kubernetes Client also has an extension for OpenShift. It is pretty much the same as Kubernetes Client but has support for some additional OpenShift resources.