diff --git a/docs/index.html b/docs/index.html
index dee8404d..15e790c6 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -6,7 +6,7 @@
 <meta http-equiv="Pragma" content="no-cache">
 <meta http-equiv="Expires" content="-1">
 <meta http-equiv="X-UA-Compatible" content="IE=edge">
-<meta content="Robot Framework 4.1.2 (Python 3.7.4 on darwin)" name="Generator">
+<meta content="Robot Framework 5.0.1 (Python 3.9.10 on darwin)" name="Generator">
 <link rel="icon" type="image/x-icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAKcAAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAAqAAAAAAAAAAAAAAAAAAAALIAAAD/AAAA4AAAANwAAADcAAAA3AAAANwAAADcAAAA3AAAANwAAADcAAAA4AAAAP8AAACxAAAAAAAAAKYAAAD/AAAAuwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAC/AAAA/wAAAKkAAAD6AAAAzAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAN8AAAD/AAAA+gAAAMMAAAAAAAAAAgAAAGsAAABrAAAAawAAAGsAAABrAAAAawAAAGsAAABrAAAADAAAAAAAAADaAAAA/wAAAPoAAADDAAAAAAAAAIsAAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAANEAAAAAAAAA2gAAAP8AAAD6AAAAwwAAAAAAAAAAAAAAMgAAADIAAAAyAAAAMgAAADIAAAAyAAAAMgAAADIAAAAFAAAAAAAAANoAAAD/AAAA+gAAAMMAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAADaAAAA/wAAAPoAAADDAAAAAAAAADwAAAB8AAAAAAAAAGAAAABcAAAAAAAAAH8AAABKAAAAAAAAAAAAAAAAAAAA2gAAAP8AAAD6AAAAwwAAAAAAAADCAAAA/wAAACkAAADqAAAA4QAAAAAAAAD7AAAA/wAAALAAAAAGAAAAAAAAANoAAAD/AAAA+gAAAMMAAAAAAAAAIwAAAP4AAAD/AAAA/wAAAGAAAAAAAAAAAAAAAMkAAAD/AAAAigAAAAAAAADaAAAA/wAAAPoAAADDAAAAAAAAAAAAAAAIAAAAcAAAABkAAAAAAAAAAAAAAAAAAAAAAAAAEgAAAAAAAAAAAAAA2gAAAP8AAAD7AAAAywAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAN4AAAD/AAAAqwAAAP8AAACvAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAALIAAAD/AAAAsgAAAAAAAAC5AAAA/wAAAMoAAADAAAAAwAAAAMAAAADAAAAAwAAAAMAAAADAAAAAwAAAAMkAAAD/AAAAvAAAAAAAAAAAAAAAAAAAAKwAAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAArQAAAAAAAAAAwAMAAIABAAAf+AAAP/wAAD/8AAAgBAAAP/wAAD/8AAA//AAAJIwAADHEAAA//AAAP/wAAB/4AACAAQAAwAMAAA==">
 <style media="all" type="text/css">
 :root {
@@ -31,6 +31,7 @@
         --highlighted-background-color: yellow;
         --less-important-text-color: #5b6a6f;
         --link-color: #52adff;
+        color-scheme: dark;
     }
 }
 body {
@@ -235,6 +236,23 @@
     content: '·';
     padding-left: 0.5rem;
 }
+.enum-type-members, .dt-usages-list {
+    list-style: none;
+    padding-left: 1em;
+}
+.dt-usages-list > li {
+    margin-bottom: 0.2em;
+}
+.dt-usages a {
+    text-decoration: none;
+    color: var(--text-color);
+    display: inline-block;
+    font-size: 0.9em;
+}
+.dt-usages a::first-letter {
+    font-weight: bold;
+    letter-spacing: 0.1em;
+}
 .arguments-list-container {
     overflow-y: auto;
 }
@@ -467,9 +485,6 @@
     display: flex;
     flex-direction: column;
 }
-.enum-type-members, .dt-usage-list {
-    list-style: none;
-}
 .data-type-container {
     border-top: 1px solid var(--border-color);
     padding: 0.5rem 1.0rem 0.5rem 1.0rem;
@@ -572,6 +587,81 @@
 .no-match .kw-name {
     color: var(--less-important-text-color);
 }
+.modal-icon {
+    cursor: pointer;
+    font-size: 12px;
+    font-weight: 600;
+    margin: 0 0.25rem;
+    width: 1rem;
+    height: 1rem;
+    padding: 0;
+    border: none;
+    background: url('data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" height="100%" width="100%"><path stroke="black" fill="none" stroke-width="2px" stroke-linecap="round" d="M1 8 L1 1 L8 1 M16 1 L23 1 L23 8 M23 16 L23 23 L16 23 M8 23 L1 23 L1 16"></path><path fill="black" stroke="none" stroke-width="1px" transform="scale(1.3) translate(-3 -2.5)" d="M19 7.97zm-8 9.2-4-2.3v-4.63l4 2.33v4.6zm1-6.33L8.04 8.53 12 6.25l3.96 2.28L12 10.84zm5 4.03-4 2.3v-4.6l4-2.33v4.63z"></path></svg>');
+}
+@media (prefers-color-scheme: dark) {
+    .modal-icon {
+        background: url('data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" height="100%" width="100%"><path stroke="%23e2e1d7" fill="none" stroke-width="2px" stroke-linecap="round" d="M1 8 L1 1 L8 1 M16 1 L23 1 L23 8 M23 16 L23 23 L16 23 M8 23 L1 23 L1 16"></path><path fill="%23e2e1d7" stroke="none" stroke-width="1px" transform="scale(1.3) translate(-3 -2.5)" d="M19 7.97zm-8 9.2-4-2.3v-4.63l4 2.33v4.6zm1-6.33L8.04 8.53 12 6.25l3.96 2.28L12 10.84zm5 4.03-4 2.3v-4.6l4-2.33v4.63z"></path></svg>');
+    }
+}
+.modal-background, .modal {
+    opacity: 0;
+    pointer-events: none;
+    transition: opacity 0.2s;
+}
+.modal-background {
+    position: fixed;
+    top: 0;
+    right: 0;
+    bottom: 0;
+    left: 0;
+    background-color: rgba(0, 0, 0, 0.7);
+    z-index: 1;
+}
+.modal {
+    display: flex;
+    flex-wrap: nowrap;
+    flex-direction: column;
+    width: 720px;
+    max-width: calc(100vw - 2rem);
+    margin: 0 auto;
+    height: calc(100vh - 6rem);
+    overflow: auto;
+    background-color: var(--background-color);
+    border: 1px solid var(--border-color);
+    border-radius: 3px;
+    z-index: 2;
+    transition-delay: 0.1s;
+}
+.modal-content {
+    margin-bottom: 3rem;
+}
+.modal > .modal-content > .data-type-container {
+    border-top: none;
+}
+.modal-close-button-wrapper {
+    display: flex;
+    justify-content: flex-end;
+}
+.modal-close-button-container {
+    width: 720px;
+    max-width: calc(100vw - 2rem);
+    margin: 0 auto;
+    overflow: auto;
+}
+.modal-close-button {
+    margin: 0.5rem 0;
+    padding: 0.25rem 0.5rem;
+    border-radius:3px;
+    border: 1px solid var(--border-color);
+    cursor: pointer;
+}
+.modal-background.visible, .modal.visible {
+    opacity: 1;
+    pointer-events: all;
+}
+#data-types-container {
+    display: none;
+}
 </style>
 <style media="all" type="text/css">
 /* Pygments 'default' style sheet. Generated with Pygments 2.1.3 using:
@@ -1102,7 +1192,7 @@
 jQuery.extend({highlight:function(e,t,n,r){if(e.nodeType===3){var i=e.data.match(t);if(i){var s=document.createElement(n||"span");s.className=r||"highlight";var o=e.splitText(i.index);o.splitText(i[0].length);var u=o.cloneNode(true);s.appendChild(u);o.parentNode.replaceChild(s,o);return 1}}else if(e.nodeType===1&&e.childNodes&&!/(script|style)/i.test(e.tagName)&&!(e.tagName===n.toUpperCase()&&e.className===r)){for(var a=0;a<e.childNodes.length;a++){a+=jQuery.highlight(e.childNodes[a],t,n,r)}}return 0}});jQuery.fn.unhighlight=function(e){var t={className:"highlight",element:"span"};jQuery.extend(t,e);return this.find(t.element+"."+t.className).each(function(){var e=this.parentNode;e.replaceChild(this.firstChild,this);e.normalize()}).end()};jQuery.fn.highlight=function(e,t){var n={className:"highlight",element:"span",caseSensitive:false,wordsOnly:false};jQuery.extend(n,t);if(e.constructor===String){e=[e]}e=jQuery.grep(e,function(e,t){return e!=""});e=jQuery.map(e,function(e,t){return e.replace(/[-[\]{}()*+?.,\\^$|#\s]/g,"\\$&")});if(e.length==0){return this}var r=n.caseSensitive?"":"i";var i="("+e.join("|")+")";if(n.wordsOnly){i="\\b"+i+"\\b"}var s=new RegExp(i,r);return this.each(function(){jQuery.highlight(this,s,n.element,n.className)})}
 </script>
 <script type="text/javascript">
-libdoc = {"name": "KubeLibrary", "doc": "<p>KubeLibrary is a Robot Framework test library for Kubernetes.</p>\n<p>The approach taken by this library is to provide easy to access kubernetes objects representation that can be then accessed to define highlevel keywords for tests.</p>\n<h2 id=\"Kubeconfigs\">Kubeconfigs</h2>\n<p>By default ~/.kube/config is used. Kubeconfig location can also be passed by setting KUBECONFIG environment variable or as Library argument.</p>\n<pre>\n<b>***</b> Settings <b>***</b>\nLibrary           KubeLibrary          /path/to/kubeconfig\n</pre>\n<h2 id=\"Context\">Context</h2>\n<p>By default current context from kubeconfig is used. Setting multiple contexts in different test suites allows working on multiple clusters.</p>\n<pre>\n<b>***</b> Settings <b>***</b>\nLibrary           KubeLibrary          context=k3d-k3d-cluster2\n</pre>\n<h2 id=\"Bearer token authentication\">Bearer token authentication</h2>\n<p>It is possible to authenticate using bearer token by passing API url, bearer token and optionally CA certificate.</p>\n<pre>\n<b>***</b> Settings <b>***</b>\nLibrary           KubeLibrary          api_url=%{K8S_API_URL}    bearer_token=%{K8S_TOKEN}    ca_cert=%{K8S_CA_CRT}\n</pre>\n<h2 id=\"In cluster execution\">In cluster execution</h2>\n<p>If tests are supposed to be executed from within cluster, KubeLibrary can be configured to use standard token authentication. Just set incluster parameter to True.</p>\n<h2 id=\"Auth methods precedence\">Auth methods precedence</h2>\n<p>If enabled, auth methods takes precedence in following order: 1. Incluster 2. Bearer Token 3. Kubeconfig</p>\n<pre>\n<b>***</b> Settings <b>***</b>\nLibrary           KubeLibrary          None    True\n</pre>", "version": "0.6.2", "generated": "2022-03-25 11:25:39", "type": "LIBRARY", "scope": "GLOBAL", "docFormat": "HTML", "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 27, "tags": [], "inits": [{"name": "Init", "args": [{"name": "kube_config", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "kube_config=None"}, {"name": "context", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "context=None"}, {"name": "api_url", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "api_url=None"}, {"name": "bearer_token", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "bearer_token=None"}, {"name": "ca_cert", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "ca_cert=None"}, {"name": "incluster", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "incluster=False"}, {"name": "cert_validation", "types": [], "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "cert_validation=True"}], "doc": "<p>KubeLibrary can be configured with several optional arguments.</p>\n<ul>\n<li><code>kube_config</code>: Path pointing to kubeconfig of target Kubernetes cluster.</li>\n<li><code>context</code>: Active context. If None current_context from kubeconfig is used.</li>\n<li><code>api_url</code>: K8s API url, used for bearer token authenticaiton.</li>\n<li><code>bearer_token</code>: Bearer token, used for bearer token authenticaiton. Do not include 'Bearer ' prefix.</li>\n<li><code>ca_cert</code>: Optional CA certificate file path, used for bearer token authenticaiton.</li>\n<li><code>incuster</code>: Default False. Indicates if used from within k8s cluster. Overrides kubeconfig.</li>\n<li><code>cert_validation</code>: Default True. Can be set to False for self-signed certificates.</li>\n</ul>\n<p>Environment variables:</p>\n<ul>\n<li>INIT_FOR_LIBDOC_ONLY: Set to '1' to generate keyword documentation and skip to load a kube config..</li>\n</ul>", "shortdoc": "KubeLibrary can be configured with several optional arguments. - ``kube_config``:   Path pointing to kubeconfig of target Kubernetes cluster. - ``context``:   Active context. If None current_context from kubeconfig is used. - ``api_url``:   K8s API url, used for bearer token authenticaiton. - ``bearer_token``:   Bearer token, used for bearer token authenticaiton. Do not include 'Bearer ' prefix. - ``ca_cert``:   Optional CA certificate file path, used for bearer token authenticaiton. - ``incuster``:   Default False. Indicates if used from within k8s cluster. Overrides kubeconfig. - ``cert_validation``:   Default True. Can be set to False for self-signed certificates.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 72}], "keywords": [{"name": "Assert Container Has Env Vars", "args": [{"name": "container", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "container"}, {"name": "env_vars_json", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "env_vars_json"}], "doc": "<p>Assert container has env vars.</p>\n<p>Returns True/False</p>\n<ul>\n<li><code>container</code>: Container object.</li>\n<li><code>env_var_json</code>: JSON representing env vars i.e.: {\"EXAMPLE_VAR\": \"examplevalue\"}</li>\n</ul>", "shortdoc": "Assert container has env vars.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 870}, {"name": "Assert Pod Has Annotations", "args": [{"name": "pod", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "pod"}, {"name": "annotations_json", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "annotations_json"}], "doc": "<p>Assert pod has annotations.</p>\n<p>Returns True/False</p>\n<ul>\n<li><code>pod</code>: Pod object.</li>\n<li><code>annotations_json</code>: JSON representing annotations</li>\n</ul>", "shortdoc": "Assert pod has annotations.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 844}, {"name": "Assert Pod Has Labels", "args": [{"name": "pod", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "pod"}, {"name": "labels_json", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "labels_json"}], "doc": "<p>Assert pod has labels.</p>\n<p>Returns True/False</p>\n<ul>\n<li><code>pod</code>: Pod object.</li>\n<li><code>labels_json</code>: JSON representing labels</li>\n</ul>", "shortdoc": "Assert pod has labels.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 818}, {"name": "Create", "args": [{"name": "api_version", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "api_version"}, {"name": "kind", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "kind"}, {"name": "kwargs", "types": [], "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<p>Creates resource instances based on the provided configuration.</p>\n<p>If the resource is namespaced (ie, not cluster-level), then one of <code>namespace</code>, <code>label_selector</code>, or <code>field_selector</code> is required. If the resource is cluster-level, then one of <code>name</code>, <code>label_selector</code>, or <code>field_selector</code> is required. Can be optionally given a kubernetes manifest (<code>body</code>) which respects the above considerations.</p>\n<ul>\n<li><code>api_version</code>: Api version of the desired kubernetes resource</li>\n<li><code>kind</code>: Kind of the desired kubernetes resource</li>\n<li><code>**kwargs</code>: Keyword arguments for argument forwarding</li>\n</ul>", "shortdoc": "Creates resource instances based on the provided configuration.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 154}, {"name": "Create Cron Job In Namespace", "args": [{"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "body", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "body"}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use create_namespaced_cron_job.</p>\n<p>Creates cron_job in a namespace</p>\n<p>Returns created cron_job</p>\n<ul>\n<li><code>body</code>: Cron_job object.</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use create_namespaced_cron_job.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 1570}, {"name": "Create Namespaced Cron Job", "args": [{"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "body", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "body"}], "doc": "<p>Creates cron_job in a namespace</p>\n<p>Returns created cron_job</p>\n<ul>\n<li><code>body</code>: Cron_job object.</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Creates cron_job in a namespace", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 1558}, {"name": "Create Namespaced Service Account", "args": [{"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "body", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "body"}], "doc": "<p>Creates service account in a namespace</p>\n<p>Returns created service account</p>\n<ul>\n<li><code>body</code>: Service Account object.</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Creates service account in a namespace", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 1121}, {"name": "Create Service Account In Namespace", "args": [{"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "body", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "body"}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use create_namespaced_service_account.</p>\n<p>Creates service account in a namespace</p>\n<p>Returns created service account</p>\n<ul>\n<li><code>body</code>: Service Account object.</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use create_namespaced_service_account.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 1134}, {"name": "Delete", "args": [{"name": "api_version", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "api_version"}, {"name": "kind", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "kind"}, {"name": "kwargs", "types": [], "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<p>Deletes resource instances based on the provided configuration.</p>\n<p>Can be optionally given a <code>namespace</code>, <code>name</code>, <code>label_selector</code>, <code>body</code> and <code>field_selector</code>.</p>\n<ul>\n<li><code>api_version</code>: Api version of the desired kubernetes resource</li>\n<li><code>kind</code>: Kind of the desired kubernetes resource</li>\n<li><code>**kwargs</code>: Keyword arguments for argument forwarding</li>\n</ul>", "shortdoc": "Deletes resource instances based on the provided configuration.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 171}, {"name": "Delete Cron Job In Namespace", "args": [{"name": "name", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use delete_namespaced_cron_job.</p>\n<p>Deletes cron_job in a namespace</p>\n<p>Returns V1 status</p>\n<ul>\n<li><code>name</code>: Cron Job name</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use delete_namespaced_cron_job.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 1596}, {"name": "Delete Namespaced Cron Job", "args": [{"name": "name", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p>Deletes cron_job in a namespace</p>\n<p>Returns V1 status</p>\n<ul>\n<li><code>name</code>: Cron Job name</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Deletes cron_job in a namespace", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 1584}, {"name": "Delete Namespaced Service Account", "args": [{"name": "name", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p>Deletes service account in a namespace</p>\n<p>Returns V1status</p>\n<ul>\n<li><code>name</code>: Service Account name</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Deletes service account in a namespace", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 1149}, {"name": "Delete Service Account In Namespace", "args": [{"name": "name", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use delete_namespaced_service_account.</p>\n<p>Deletes service account in a namespace</p>\n<p>Returns V1status</p>\n<ul>\n<li><code>name</code>: Service Account name</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use delete_namespaced_service_account.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 1163}, {"name": "Evaluate Callable From K8s Client", "args": [{"name": "attr_name", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "attr_name"}, {"name": "args", "types": [], "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*args"}, {"name": "kwargs", "types": [], "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<p>Evaluates a callable from kubernetes client.</p>\n<p>Returns the output of the client callable.</p>\n<ul>\n<li><code>attr_name</code>: Callable name</li>\n<li><code>*args</code>: Positional arguments for argument forwarding</li>\n<li><code>**kwargs</code>: Keyword arguments for argument forwarding</li>\n</ul>", "shortdoc": "Evaluates a callable from kubernetes client.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 111}, {"name": "Filter By Key", "args": [{"name": "objects", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "objects"}, {"name": "key", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key"}, {"name": "match", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "match"}], "doc": "<p>Filter object with key matching value for list of k8s objects.</p>\n<p>Returns list of objects.</p>\n<ul>\n<li><code>objects</code>: List of k8s objects</li>\n<li><code>key</code>: Key to match</li>\n<li><code>match</code>: Value of the key based on which objects will be included</li>\n</ul>", "shortdoc": "Filter object with key matching value for list of k8s objects.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 670}, {"name": "Filter Configmap Names", "args": [{"name": "configmaps", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "configmaps"}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. See examples in TBD. Filter configmap  names for list of configmaps. Returns list of strings.</p>\n<ul>\n<li><code>configmaps</code>: List of configmap objects</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. See examples in TBD. Filter configmap  names for list of configmaps. Returns list of strings. - ``configmaps``:   List of configmap objects", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 722}, {"name": "Filter Containers Images", "args": [{"name": "containers", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "containers"}], "doc": "<p>Filters container images for given lists of containers.</p>\n<p>Returns list of images.</p>\n<ul>\n<li><code>containers</code>: List of containers</li>\n</ul>", "shortdoc": "Filters container images for given lists of containers.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 757}, {"name": "Filter Containers Resources", "args": [{"name": "containers", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "containers"}], "doc": "<p>Filters container resources for given lists of containers.</p>\n<p>Returns list of resources.</p>\n<ul>\n<li><code>containers</code>: List of containers</li>\n</ul>", "shortdoc": "Filters container resources for given lists of containers.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 768}, {"name": "Filter Deployments Names", "args": [{"name": "deployments", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "deployments"}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. See examples in TBD. Returns list of strings.</p>\n<ul>\n<li><code>deployments</code>: List of deployments objects</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. See examples in TBD. Returns list of strings. - ``deployments``:   List of deployments objects", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 684}, {"name": "Filter Endpoints Names", "args": [{"name": "endpoints", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "endpoints"}], "doc": "<p>Filter endpoints names for list of endpoints. Returns list of strings.</p>\n<ul>\n<li><code>endpoints</code>:</li>\n</ul>\n<p>List of endpoint objects</p>", "shortdoc": "Filter endpoints names for list of endpoints. Returns list of strings. - ``endpoints``: List of endpoint objects", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 731}, {"name": "Filter Names", "args": [{"name": "objects", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "objects"}], "doc": "<p>Filter .metadata.name for list of k8s objects.</p>\n<p>Returns list of strings.</p>\n<ul>\n<li><code>objects</code>: List of k8s objects</li>\n</ul>", "shortdoc": "Filter .metadata.name for list of k8s objects.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 660}, {"name": "Filter Pods Containers By Name", "args": [{"name": "pods", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "pods"}, {"name": "name_pattern", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name_pattern"}], "doc": "<p>Filters pods containers by name for given list of pods.</p>\n<p>Returns lists of containers (flattens).</p>\n<ul>\n<li><code>pods</code>: List of pods objects</li>\n</ul>", "shortdoc": "Filters pods containers by name for given list of pods.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 740}, {"name": "Filter Pods Containers Statuses By Name", "args": [{"name": "pods", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "pods"}, {"name": "name_pattern", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name_pattern"}], "doc": "<p>Filters pods containers statuses by container name for given list of pods.</p>\n<p>Returns lists of containers statuses.</p>\n<ul>\n<li><code>pods</code>: List of pods objects</li>\n</ul>", "shortdoc": "Filters pods containers statuses by container name for given list of pods.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 779}, {"name": "Filter Pods Names", "args": [{"name": "pods", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "pods"}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. See examples in TBD. Filter pod names for list of pods.</p>\n<p>Returns list of strings.</p>\n<ul>\n<li><code>pods</code>: List of pods objects</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. See examples in TBD. Filter pod names for list of pods.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 700}, {"name": "Filter Replicasets Names", "args": [{"name": "replicasets", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "replicasets"}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. See examples in TBD. Returns list of strings.</p>\n<ul>\n<li><code>replicasets</code>: List of replicasets objects</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. See examples in TBD. Returns list of strings. - ``replicasets``:   List of replicasets objects", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 692}, {"name": "Filter Service Accounts Names", "args": [{"name": "service_accounts", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "service_accounts"}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. See examples in TBD. Filter service accounts names for list of service accounts.</p>\n<p>Returns list of strings.</p>\n<ul>\n<li><code>service_accounts</code>: List of service accounts objects</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. See examples in TBD. Filter service accounts names for list of service accounts.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 711}, {"name": "Generate Alphanumeric Str", "args": [{"name": "size", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "size"}], "doc": "<p>Generates a random alphanumeric string with given size.</p>\n<p>Returns a string.</p>\n<ul>\n<li><code>size</code>: Desired size of the output string</li>\n</ul>", "shortdoc": "Generates a random alphanumeric string with given size.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 100}, {"name": "Get", "args": [{"name": "api_version", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "api_version"}, {"name": "kind", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "kind"}, {"name": "kwargs", "types": [], "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<p>Retrieves resource instances based on the provided parameters.</p>\n<p>Can be optionally given a <code>namespace</code>, <code>name</code>, <code>label_selector</code>, <code>body</code> and <code>field_selector</code>.</p>\n<p>Returns a resource list.</p>\n<ul>\n<li><code>api_version</code>: Api version of the desired kubernetes resource</li>\n<li><code>kind</code>: Kind of the desired kubernetes resource</li>\n<li><code>**kwargs</code>: Keyword arguments for argument forwarding</li>\n</ul>", "shortdoc": "Retrieves resource instances based on the provided parameters.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 137}, {"name": "Get Cluster Custom Object", "args": [{"name": "group", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "group"}, {"name": "version", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "version"}, {"name": "plural", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "plural"}, {"name": "name", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}], "doc": "<p>Get cluster level custom object.</p>\n<p>Returns an object.</p>\n<ul>\n<li><code>group</code>: API Group, e.g. 'scheduling.k8s.io'</li>\n<li><code>version</code>: API version, e.g. 'v1'</li>\n<li><code>plural</code>: e.g. 'priorityclasses'</li>\n<li><code>name</code>: e.g. 'system-node-critical'</li>\n</ul>\n<p>As in <code>GET /apis/{group}/{version}/{plural}/{name}</code></p>\n<p><a href=\"https://github.com/kubernetes-client/python/blob/master/kubernetes/README.md\">https://github.com/kubernetes-client/python/blob/master/kubernetes/README.md</a></p>", "shortdoc": "Get cluster level custom object.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 1492}, {"name": "Get Cluster Role Bindings", "args": [], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use list_cluster_role_binding.</p>\n<p>Gets a list of cluster_role_bindings.</p>\n<p>Returns list of cluster_role_bindings.</p>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use list_cluster_role_binding.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 1396}, {"name": "Get Cluster Roles", "args": [], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use list_cluster_role.</p>\n<p>Gets a list of cluster_roles.</p>\n<p>Returns list of cluster_roles.</p>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use list_cluster_role.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 1378}, {"name": "Get Configmaps In Namespace", "args": [{"name": "name_pattern", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name_pattern"}, {"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use list_namespaced_config_map_by_pattern. Gets configmaps matching pattern in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of configmaps.</p>\n<ul>\n<li><code>name_pattern</code>: configmap name pattern to check</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use list_namespaced_config_map_by_pattern. Gets configmaps matching pattern in given namespace.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 428}, {"name": "Get Cron Job Details In Namespace", "args": [{"name": "name", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use read_namespaced_cron_job.</p>\n<p>Gets cron job details in given namespace.</p>\n<p>Returns Cron job object representation.</p>\n<ul>\n<li><code>name</code>: Name of cron job.</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use read_namespaced_cron_job.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 1299}, {"name": "Get Cron Jobs In Namespace", "args": [{"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use list_namespaced_cron_job.</p>\n<p>Gets cron jobs in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of strings.</p>\n<ul>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use list_namespaced_cron_job.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 1271}, {"name": "Get Custom Object In Namespace", "args": [{"name": "group", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "group"}, {"name": "version", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "version"}, {"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "plural", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "plural"}, {"name": "name", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use get_namespaced_custom_object.</p>\n<p>Get custom object in namespace.</p>\n<p>Returns an object.</p>\n<ul>\n<li><code>group</code>: API Group, e.g. 'k8s.cni.cncf.io'</li>\n<li><code>version</code>: API version, e.g. 'v1'</li>\n<li><code>namespace</code>: Namespace, e.g. 'default'</li>\n<li><code>plural</code>: e.g. 'network-attachment-definitions'</li>\n<li><code>name</code>: e.g. 'my-network'</li>\n</ul>\n<p>As in <code>GET /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}</code></p>\n<p><a href=\"https://github.com/kubernetes-client/python/blob/master/kubernetes/README.md\">https://github.com/kubernetes-client/python/blob/master/kubernetes/README.md</a></p>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use get_namespaced_custom_object.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 1534}, {"name": "Get Daemonset Details In Namespace", "args": [{"name": "name", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use read_namespaced_daemon_set.</p>\n<p>Gets deamonset details in given namespace.</p>\n<p>Returns daemonset object representation.</p>\n<ul>\n<li><code>name</code>: Name of the daemonset</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use read_namespaced_daemon_set.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 1355}, {"name": "Get Daemonsets In Namespace", "args": [{"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use list_namespaced_daemon_set.</p>\n<p>Gets a list of available daemonsets.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of deaemonsets.</p>\n<ul>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use list_namespaced_daemon_set.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 1327}, {"name": "Get Deployments In Namespace", "args": [{"name": "name_pattern", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name_pattern"}, {"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use list_namespaced_deployment_by_pattern. Gets deployments matching pattern in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of deployments.</p>\n<ul>\n<li><code>name_pattern</code>: deployment name pattern to check</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use list_namespaced_deployment_by_pattern. Gets deployments matching pattern in given namespace.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 498}, {"name": "Get Dynamic Resource", "args": [{"name": "api_version", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "api_version"}, {"name": "kind", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "kind"}], "doc": "<p>Returns a dynamic resource based on the provided api version and kind.</p>\n<ul>\n<li><code>api_version</code>: Api version of the desired kubernetes resource</li>\n<li><code>kind</code>: Kind of the desired kubernetes resource</li>\n</ul>", "shortdoc": "Returns a dynamic resource based on the provided api version and kind.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 127}, {"name": "Get Endpoints In Namespace", "args": [{"name": "name", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use read_namespaced_endpoints.</p>\n<p>Gets endpoint details in given namespace.</p>\n<p>Returns Endpoint object representation. Can be accessed using</p>\n<table border=\"1\">\n<tr>\n<td>Should Match</td>\n<td>${endpoint_details.subsets[0].addresses[0].target_ref.name}</td>\n<td>pod-name-123456</td>\n</tr>\n</table>\n<ul>\n<li><code>name</code>: Name of endpoint.</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use read_namespaced_endpoints.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 1034}, {"name": "Get Healthcheck", "args": [{"name": "endpoint", "types": [], "defaultValue": "/readyz", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "endpoint=/readyz"}, {"name": "verbose", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "verbose=False"}], "doc": "<p>Performs GET on /readyz or /livez for simple health check.</p>\n<p>Can be used to verify the readiness/current status of the API server Returns tuple of (response data, response status and response headers)</p>\n<ul>\n<li><code>endpoint</code>: /readyz, /livez or induvidual endpoints like '/livez/etcd'. defaults to /readyz</li>\n<li><code>verbose</code>: More detailed output.</li>\n</ul>\n<p><a href=\"https://kubernetes.io/docs/reference/using-api/health-checks\">https://kubernetes.io/docs/reference/using-api/health-checks</a></p>", "shortdoc": "Performs GET on /readyz or /livez for simple health check.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 1179}, {"name": "Get Healthy Nodes Count", "args": [{"name": "label_selector", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p>Counts node with KubeletReady and status True.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Can be used to check number of healthy nodes. Can be used as prerequisite in tests.</p>", "shortdoc": "Counts node with KubeletReady and status True.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 313}, {"name": "Get Hpa Details In Namespace", "args": [{"name": "name", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use list_namespaced_horizontal_pod_autoscaler.</p>\n<p>Gets Horizontal Pod Autoscaler details in given namespace.</p>\n<p>Returns Horizontal Pod Autoscaler object representation. Can be accessed using</p>\n<table border=\"1\">\n<tr>\n<td>Should Be Equal As integers</td>\n<td>${hpa_details.spec.target_cpu_utilization_percentage}</td>\n<td>50</td>\n</tr>\n</table>\n<ul>\n<li><code>name</code>: Name of Horizontal Pod Autoscaler</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use list_namespaced_horizontal_pod_autoscaler.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 1002}, {"name": "Get Hpas In Namespace", "args": [{"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use list_namespaced_horizontal_pod_autoscaler.</p>\n<p>Gets Horizontal Pod Autoscalers in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of strings.</p>\n<ul>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use list_namespaced_horizontal_pod_autoscaler.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 972}, {"name": "Get Ingress Details In Namespace", "args": [{"name": "name", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use read_namespaced_ingress.</p>\n<p>Gets ingress details in given namespace.</p>\n<p>Returns Ingress object representation. Name of ingress.</p>\n<ul>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use read_namespaced_ingress.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 1245}, {"name": "Get Ingresses In Namespace", "args": [{"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use list_namespaced_ingress.</p>\n<p>Gets ingresses in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value Returns list of strings.</p>\n<ul>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use list_namespaced_ingress.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 1221}, {"name": "Get Jobs In Namespace", "args": [{"name": "name_pattern", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name_pattern"}, {"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use list_namespaced_job_by_pattern. Gets jobs matching pattern in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of jobs.</p>\n<ul>\n<li><code>name_pattern</code>: job name pattern to check</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use list_namespaced_job_by_pattern. Gets jobs matching pattern in given namespace.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 568}, {"name": "Get Kubelet Version", "args": [{"name": "label_selector", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p>Gets list of kubelet versions on each node.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of strings.</p>", "shortdoc": "Gets list of kubelet versions on each node.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 1111}, {"name": "Get Namespaced Custom Object", "args": [{"name": "group", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "group"}, {"name": "version", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "version"}, {"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "plural", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "plural"}, {"name": "name", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}], "doc": "<p>Get custom object in namespace.</p>\n<p>Returns an object.</p>\n<ul>\n<li><code>group</code>: API Group, e.g. 'k8s.cni.cncf.io'</li>\n<li><code>version</code>: API version, e.g. 'v1'</li>\n<li><code>namespace</code>: Namespace, e.g. 'default'</li>\n<li><code>plural</code>: e.g. 'network-attachment-definitions'</li>\n<li><code>name</code>: e.g. 'my-network'</li>\n</ul>\n<p>As in <code>GET /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}</code></p>\n<p><a href=\"https://github.com/kubernetes-client/python/blob/master/kubernetes/README.md\">https://github.com/kubernetes-client/python/blob/master/kubernetes/README.md</a></p>", "shortdoc": "Get custom object in namespace.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 1512}, {"name": "Get Namespaced Pod Exec", "args": [{"name": "name", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "argv_cmd", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "argv_cmd"}, {"name": "container", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "container=None"}], "doc": "<p>Exec command on selected container for POD.</p>\n<p>Returns command stdout/stderr</p>\n<ul>\n<li><code>name</code>: pod name</li>\n<li><code>namespace</code>: namespace to check</li>\n<li><code>argv_cmd</code>: command to be executed using argv syntax: [\"/bin/sh\", \"-c\", \"ls\"] it do not use shell as default!</li>\n<li><code>container</code>: container on which we run exec, default: None</li>\n</ul>", "shortdoc": "Exec command on selected container for POD.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 621}, {"name": "Get Namespaces", "args": [{"name": "label_selector", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use list_namespace. Gets a list of available namespaces.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of namespaces names.</p>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use list_namespace. Gets a list of available namespaces.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 303}, {"name": "Get Pod Logs", "args": [{"name": "name", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "container", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "container"}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use read_namespaced_pod_log. Gets container logs of given pod in given namespace.</p>\n<p>Returns logs.</p>\n<ul>\n<li><code>name</code>: Pod name to check</li>\n<li><code>namespace</code>: Namespace to check</li>\n<li><code>container</code>: Container to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use read_namespaced_pod_log. Gets container logs of given pod in given namespace.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 395}, {"name": "Get Pod Names In Namespace", "args": [{"name": "name_pattern", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name_pattern"}, {"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use list_namespaced_pod_by_pattern. Gets pod name matching pattern in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of strings.</p>\n<ul>\n<li><code>name_pattern</code>: Pod name pattern to check</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use list_namespaced_pod_by_pattern. Gets pod name matching pattern in given namespace.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 328}, {"name": "Get Pod Status In Namespace", "args": [{"name": "name", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use read_namespaced_pod_status.</p>\n<ul>\n<li><code>name</code>: Name of pod.</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use read_namespaced_pod_status.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 806}, {"name": "Get Pods In Namespace", "args": [{"name": "name_pattern", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name_pattern"}, {"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use list_namespaced_pod_by_pattern. Gets pods matching pattern in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of pods.</p>\n<ul>\n<li><code>name_pattern</code>: Pod name pattern to check</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use list_namespaced_pod_by_pattern. Gets pods matching pattern in given namespace.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 362}, {"name": "Get Pvc Capacity", "args": [{"name": "name", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use read_namespaced_persistent_volume_claim.</p>\n<p>Gets PVC details in given namespace.</p>\n<p>Returns PVC object representation. Can be accessed using</p>\n<table border=\"1\">\n<tr>\n<td>Should Be Equal As strings</td>\n<td>${pvc.status.capacity.storage}</td>\n<td>1Gi</td>\n</tr>\n</table>\n<ul>\n<li><code>name</code>: Name of PVC.</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use read_namespaced_persistent_volume_claim.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 1094}, {"name": "Get Pvc In Namespace", "args": [{"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use list_namespaced_persistent_volume_claim.</p>\n<p>Gets pvcs in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of strings.</p>\n<ul>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use list_namespaced_persistent_volume_claim.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 1064}, {"name": "Get Replicasets In Namespace", "args": [{"name": "name_pattern", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name_pattern"}, {"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use list_namespaced_replica_set_by_pattern. Gets replicasets matching pattern in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of  replicasets.</p>\n<ul>\n<li><code>name_pattern</code>: replicaset name pattern to check</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use list_namespaced_replica_set_by_pattern. Gets replicasets matching pattern in given namespace.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 533}, {"name": "Get Role Bindings In Namespace", "args": [{"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use list_namespaced_role_binding.</p>\n<p>Gets role_bindings in given namespace.</p>\n<p>Returns list of role_bindings.</p>\n<ul>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use list_namespaced_role_binding.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 1441}, {"name": "Get Roles In Namespace", "args": [{"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use list_namespaced_role.</p>\n<p>Gets roles in given namespace.</p>\n<p>Returns list of roles.</p>\n<ul>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use list_namespaced_role.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 1417}, {"name": "Get Secrets In Namespace", "args": [{"name": "name_pattern", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name_pattern"}, {"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use list_namespaced_secret_by_pattern. Gets secrets matching pattern in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of secrets.</p>\n<ul>\n<li><code>name_pattern</code>: secret name pattern to check</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use list_namespaced_secret_by_pattern. Gets secrets matching pattern in given namespace.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 603}, {"name": "Get Service Accounts In Namespace", "args": [{"name": "name_pattern", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name_pattern"}, {"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use list_namespaced_service_account_by_pattern. Gets service accounts matching pattern in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of service accounts.</p>\n<ul>\n<li><code>name_pattern</code>: Service Account name pattern to check</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use list_namespaced_service_account_by_pattern. Gets service accounts matching pattern in given namespace.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 463}, {"name": "Get Service Details In Namespace", "args": [{"name": "name", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use read_namespaced_service.</p>\n<p>Gets service details in given namespace.</p>\n<p>Returns Service object representation. Can be accessed using</p>\n<table border=\"1\">\n<tr>\n<td>Should Be Equal As integers</td>\n<td>${service_details.spec.ports[0].port}</td>\n<td>8080</td>\n</tr>\n</table>\n<ul>\n<li><code>name</code>: Name of service.</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use read_namespaced_service.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 942}, {"name": "Get Services In Namespace", "args": [{"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use list_namespaced_service.</p>\n<p>Gets services in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of strings.</p>\n<ul>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use list_namespaced_service.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 912}, {"name": "K8s Api Ping", "args": [], "doc": "<p>Performs GET on /api/v1/ for simple check of API availability.</p>\n<p>Returns tuple of (response data, response status, response headers). Can be used as prerequisite in tests.</p>", "shortdoc": "Performs GET on /api/v1/ for simple check of API availability.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 274}, {"name": "List Cluster Custom Object", "args": [{"name": "group", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "group"}, {"name": "version", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "version"}, {"name": "plural", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "plural"}], "doc": "<p>Lists cluster level custom objects.</p>\n<p>Returns an object.</p>\n<ul>\n<li><code>group</code>: API Group, e.g. 'k8s.cni.cncf.io'</li>\n<li><code>version</code>: API version, e.g. 'v1'</li>\n<li><code>plural</code>: e.g. 'network-attachment-definitions'</li>\n</ul>\n<p>As in <code>GET /apis/{group}/{version}/{plural}</code></p>\n<p><a href=\"https://github.com/kubernetes-client/python/blob/master/kubernetes/README.md\">https://github.com/kubernetes-client/python/blob/master/kubernetes/README.md</a></p>", "shortdoc": "Lists cluster level custom objects.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 1454}, {"name": "List Cluster Custom Objects", "args": [{"name": "group", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "group"}, {"name": "version", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "version"}, {"name": "plural", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "plural"}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use list_cluster_custom_object.</p>\n<p>Lists cluster level custom objects.</p>\n<p>Returns an object.</p>\n<ul>\n<li><code>group</code>: API Group, e.g. 'k8s.cni.cncf.io'</li>\n<li><code>version</code>: API version, e.g. 'v1'</li>\n<li><code>plural</code>: e.g. 'network-attachment-definitions'</li>\n</ul>\n<p>As in <code>GET /apis/{group}/{version}/{plural}</code></p>\n<p><a href=\"https://github.com/kubernetes-client/python/blob/master/kubernetes/README.md\">https://github.com/kubernetes-client/python/blob/master/kubernetes/README.md</a></p>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use list_cluster_custom_object.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 1472}, {"name": "List Cluster Role", "args": [], "doc": "<p>Gets a list of cluster_roles.</p>\n<p>Returns list of cluster_roles.</p>", "shortdoc": "Gets a list of cluster_roles.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 1370}, {"name": "List Cluster Role Binding", "args": [], "doc": "<p>Gets a list of cluster_role_bindings.</p>\n<p>Returns list of cluster_role_bindings.</p>", "shortdoc": "Gets a list of cluster_role_bindings.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 1388}, {"name": "List Namespace", "args": [{"name": "label_selector", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p>Lists available namespaces.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of namespaces.</p>", "shortdoc": "Lists available namespaces.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 293}, {"name": "List Namespaced Config Map By Pattern", "args": [{"name": "name_pattern", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name_pattern"}, {"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p>Lists configmaps matching pattern in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of configmaps.</p>\n<ul>\n<li><code>name_pattern</code>: configmap name pattern to check</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Lists configmaps matching pattern in given namespace.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 411}, {"name": "List Namespaced Cron Job", "args": [{"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p>Gets cron jobs in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of strings.</p>\n<ul>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Gets cron jobs in given namespace.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 1258}, {"name": "List Namespaced Daemon Set", "args": [{"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p>Gets a list of available daemonsets.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of deaemonsets.</p>\n<ul>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Gets a list of available daemonsets.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 1314}, {"name": "List Namespaced Deployment By Pattern", "args": [{"name": "name_pattern", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name_pattern"}, {"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p>Gets deployments matching pattern in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of deployments.</p>\n<ul>\n<li><code>name_pattern</code>: deployment name pattern to check</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Gets deployments matching pattern in given namespace.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 481}, {"name": "List Namespaced Horizontal Pod Autoscaler", "args": [{"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p>Gets Horizontal Pod Autoscalers in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of strings.</p>\n<ul>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Gets Horizontal Pod Autoscalers in given namespace.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 959}, {"name": "List Namespaced Ingress", "args": [{"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p>Gets ingresses in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value Returns list of strings.</p>\n<ul>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Gets ingresses in given namespace.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 1210}, {"name": "List Namespaced Job By Pattern", "args": [{"name": "name_pattern", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name_pattern"}, {"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p>Gets jobs matching pattern in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of jobs.</p>\n<ul>\n<li><code>name_pattern</code>: job name pattern to check</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Gets jobs matching pattern in given namespace.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 551}, {"name": "List Namespaced Persistent Volume Claim", "args": [{"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p>Gets pvcs in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of strings.</p>\n<ul>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Gets pvcs in given namespace.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 1051}, {"name": "List Namespaced Pod By Pattern", "args": [{"name": "name_pattern", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name_pattern"}, {"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p>List pods matching pattern in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of pods.</p>\n<ul>\n<li><code>name_pattern</code>: Pod name pattern to check</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "List pods matching pattern in given namespace.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 345}, {"name": "List Namespaced Replica Set By Pattern", "args": [{"name": "name_pattern", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name_pattern"}, {"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p>Lists replicasets matching pattern in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of  replicasets.</p>\n<ul>\n<li><code>name_pattern</code>: replicaset name pattern to check</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Lists replicasets matching pattern in given namespace.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 516}, {"name": "List Namespaced Role", "args": [{"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p>Gets roles in given namespace.</p>\n<p>Returns list of roles.</p>\n<ul>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Gets roles in given namespace.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 1406}, {"name": "List Namespaced Role Binding", "args": [{"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p>Gets role_bindings in given namespace.</p>\n<p>Returns list of role_bindings.</p>\n<ul>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Gets role_bindings in given namespace.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 1430}, {"name": "List Namespaced Secret By Pattern", "args": [{"name": "name_pattern", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name_pattern"}, {"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p>Lists secrets matching pattern in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of secrets.</p>\n<ul>\n<li><code>name_pattern</code>: secret name pattern to check</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Lists secrets matching pattern in given namespace.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 586}, {"name": "List Namespaced Service", "args": [{"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p>Gets services in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of strings.</p>\n<ul>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Gets services in given namespace.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 899}, {"name": "List Namespaced Service Account By Pattern", "args": [{"name": "name_pattern", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name_pattern"}, {"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p>Lists service accounts matching pattern in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of service accounts.</p>\n<ul>\n<li><code>name_pattern</code>: Service Account name pattern to check</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Lists service accounts matching pattern in given namespace.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 446}, {"name": "Patch", "args": [{"name": "api_version", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "api_version"}, {"name": "kind", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "kind"}, {"name": "kwargs", "types": [], "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<p>Patches resource instances based on the provided parameters.</p>\n<p>Can be optionally given a <code>namespace</code>, <code>name</code>, <code>label_selector</code>, <code>body</code> and <code>field_selector</code>.</p>\n<ul>\n<li><code>api_version</code>: Api version of the desired kubernetes resource</li>\n<li><code>kind</code>: Kind of the desired kubernetes resource</li>\n<li><code>**kwargs</code>: Keyword arguments for argument forwarding</li>\n</ul>", "shortdoc": "Patches resource instances based on the provided parameters.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 186}, {"name": "Read Namespaced Cron Job", "args": [{"name": "name", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p>Gets cron job details in given namespace.</p>\n<p>Returns Cron job object representation.</p>\n<ul>\n<li><code>name</code>: Name of cron job.</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Gets cron job details in given namespace.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 1286}, {"name": "Read Namespaced Daemon Set", "args": [{"name": "name", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p>Gets deamonset details in given namespace.</p>\n<p>Returns daemonset object representation.</p>\n<ul>\n<li><code>name</code>: Name of the daemonset</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Gets deamonset details in given namespace.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 1342}, {"name": "Read Namespaced Endpoints", "args": [{"name": "name", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p>Gets endpoint details in given namespace.</p>\n<p>Returns Endpoint object representation. Can be accessed using</p>\n<table border=\"1\">\n<tr>\n<td>Should Match</td>\n<td>${endpoint_details.subsets[0].addresses[0].target_ref.name}</td>\n<td>pod-name-123456</td>\n</tr>\n</table>\n<ul>\n<li><code>name</code>: Name of endpoint.</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Gets endpoint details in given namespace.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 1019}, {"name": "Read Namespaced Horizontal Pod Autoscaler", "args": [{"name": "name", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p>Gets Horizontal Pod Autoscaler details in given namespace.</p>\n<p>Returns Horizontal Pod Autoscaler object representation. Can be accessed using</p>\n<table border=\"1\">\n<tr>\n<td>Should Be Equal As integers</td>\n<td>${hpa_details.spec.target_cpu_utilization_percentage}</td>\n<td>50</td>\n</tr>\n</table>\n<ul>\n<li><code>name</code>: Name of Horizontal Pod Autoscaler</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Gets Horizontal Pod Autoscaler details in given namespace.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 987}, {"name": "Read Namespaced Ingress", "args": [{"name": "name", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p>Gets ingress details in given namespace.</p>\n<p>Returns Ingress object representation. Name of ingress.</p>\n<ul>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Gets ingress details in given namespace.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 1234}, {"name": "Read Namespaced Persistent Volume Claim", "args": [{"name": "name", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p>Gets PVC details in given namespace.</p>\n<p>Returns PVC object representation. Can be accessed using</p>\n<table border=\"1\">\n<tr>\n<td>Should Be Equal As strings</td>\n<td>${pvc.status.capacity.storage}</td>\n<td>1Gi</td>\n</tr>\n</table>\n<ul>\n<li><code>name</code>: Name of PVC.</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Gets PVC details in given namespace.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 1079}, {"name": "Read Namespaced Pod Log", "args": [{"name": "name", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "container", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "container"}], "doc": "<p>Gets container logs of given pod in given namespace.</p>\n<p>Returns logs.</p>\n<ul>\n<li><code>name</code>: Pod name to check</li>\n<li><code>namespace</code>: Namespace to check</li>\n<li><code>container</code>: Container to check</li>\n</ul>", "shortdoc": "Gets container logs of given pod in given namespace.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 380}, {"name": "Read Namespaced Pod Status", "args": [{"name": "name", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p>Reads pod status in given namespace.</p>\n<ul>\n<li><code>name</code>: Name of pod.</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Reads pod status in given namespace.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 795}, {"name": "Read Namespaced Service", "args": [{"name": "name", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "namespace", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p>Gets service details in given namespace.</p>\n<p>Returns Service object representation. Can be accessed using</p>\n<table border=\"1\">\n<tr>\n<td>Should Be Equal As integers</td>\n<td>${service_details.spec.ports[0].port}</td>\n<td>8080</td>\n</tr>\n</table>\n<ul>\n<li><code>name</code>: Name of service.</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Gets service details in given namespace.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 927}, {"name": "Reload Config", "args": [{"name": "kube_config", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "kube_config=None"}, {"name": "context", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "context=None"}, {"name": "api_url", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "api_url=None"}, {"name": "bearer_token", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "bearer_token=None"}, {"name": "ca_cert", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "ca_cert=None"}, {"name": "incluster", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "incluster=False"}, {"name": "cert_validation", "types": [], "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "cert_validation=True"}], "doc": "<p>Reload the KubeLibrary to be configured with different optional arguments. This can be used to connect to a different cluster during the same test.</p>\n<ul>\n<li><code>kube_config</code>: Path pointing to kubeconfig of target Kubernetes cluster.</li>\n<li><code>context</code>: Active context. If None current_context from kubeconfig is used.</li>\n<li><code>api_url</code>: K8s API url, used for bearer token authenticaiton.</li>\n<li><code>bearer_token</code>: Bearer token, used for bearer token authenticaiton. Do not include 'Bearer ' prefix.</li>\n<li><code>ca_cert</code>: Optional CA certificate file path, used for bearer token authenticaiton.</li>\n<li><code>incuster</code>: Default False. Indicates if used from within k8s cluster. Overrides kubeconfig.</li>\n<li><code>cert_validation</code>: Default True. Can be set to False for self-signed certificates.</li>\n</ul>", "shortdoc": "Reload the KubeLibrary to be configured with different optional arguments.    This can be used to connect to a different cluster during the same test. - ``kube_config``:   Path pointing to kubeconfig of target Kubernetes cluster. - ``context``:   Active context. If None current_context from kubeconfig is used. - ``api_url``:   K8s API url, used for bearer token authenticaiton. - ``bearer_token``:   Bearer token, used for bearer token authenticaiton. Do not include 'Bearer ' prefix. - ``ca_cert``:   Optional CA certificate file path, used for bearer token authenticaiton. - ``incuster``:   Default False. Indicates if used from within k8s cluster. Overrides kubeconfig. - ``cert_validation``:   Default True. Can be set to False for self-signed certificates.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 216}, {"name": "Replace", "args": [{"name": "api_version", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "api_version"}, {"name": "kind", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "kind"}, {"name": "kwargs", "types": [], "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<p>Replaces resource instances based on the provided parameters.</p>\n<p>Can be optionally given a <code>namespace</code>, <code>name</code>, <code>label_selector</code>, <code>body</code> and <code>field_selector</code>.</p>\n<ul>\n<li><code>api_version</code>: Api version of the desired kubernetes resource</li>\n<li><code>kind</code>: Kind of the desired kubernetes resource</li>\n<li><code>**kwargs</code>: Keyword arguments for argument forwarding</li>\n</ul>", "shortdoc": "Replaces resource instances based on the provided parameters.", "tags": [], "source": "/Users/Marcin/virtualenvs/kubelibrary/lib/python3.7/site-packages/robotframework_kubelibrary-0.6.2-py3.7.egg/KubeLibrary/KubeLibrary.py", "lineno": 201}], "dataTypes": {"enums": [], "typedDicts": []}}
+libdoc = {"specversion": 1, "name": "KubeLibrary", "doc": "<p>KubeLibrary is a Robot Framework test library for Kubernetes.</p>\n<p>The approach taken by this library is to provide easy to access kubernetes objects representation that can be then accessed to define highlevel keywords for tests.</p>\n<h2 id=\"Kubeconfigs\">Kubeconfigs</h2>\n<p>By default ~/.kube/config is used. Kubeconfig location can also be passed by setting KUBECONFIG environment variable or as Library argument.</p>\n<pre>\n<b>***</b> Settings <b>***</b>\nLibrary           KubeLibrary          /path/to/kubeconfig\n</pre>\n<h2 id=\"Context\">Context</h2>\n<p>By default current context from kubeconfig is used. Setting multiple contexts in different test suites allows working on multiple clusters.</p>\n<pre>\n<b>***</b> Settings <b>***</b>\nLibrary           KubeLibrary          context=k3d-k3d-cluster2\n</pre>\n<h2 id=\"Bearer token authentication\">Bearer token authentication</h2>\n<p>It is possible to authenticate using bearer token by passing API url, bearer token and optionally CA certificate.</p>\n<pre>\n<b>***</b> Settings <b>***</b>\nLibrary           KubeLibrary          api_url=%{K8S_API_URL}    bearer_token=%{K8S_TOKEN}    ca_cert=%{K8S_CA_CRT}\n</pre>\n<h2 id=\"In cluster execution\">In cluster execution</h2>\n<p>If tests are supposed to be executed from within cluster, KubeLibrary can be configured to use standard token authentication. Just set incluster parameter to True.</p>\n<h2 id=\"Auth methods precedence\">Auth methods precedence</h2>\n<p>If enabled, auth methods takes precedence in following order: 1. Incluster 2. Bearer Token 3. Kubeconfig</p>\n<pre>\n<b>***</b> Settings <b>***</b>\nLibrary           KubeLibrary          None    True\n</pre>", "version": "0.7.0", "generated": "2022-06-23 16:54:31", "type": "LIBRARY", "scope": "GLOBAL", "docFormat": "HTML", "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 27, "tags": [], "inits": [{"name": "__init__", "args": [{"name": "kube_config", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "kube_config=None"}, {"name": "context", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "context=None"}, {"name": "api_url", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "api_url=None"}, {"name": "bearer_token", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "bearer_token=None"}, {"name": "ca_cert", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "ca_cert=None"}, {"name": "incluster", "types": [], "typedocs": {}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "incluster=False"}, {"name": "cert_validation", "types": [], "typedocs": {}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "cert_validation=True"}], "doc": "<p>KubeLibrary can be configured with several optional arguments.</p>\n<ul>\n<li><code>kube_config</code>: Path pointing to kubeconfig of target Kubernetes cluster.</li>\n<li><code>context</code>: Active context. If None current_context from kubeconfig is used.</li>\n<li><code>api_url</code>: K8s API url, used for bearer token authenticaiton.</li>\n<li><code>bearer_token</code>: Bearer token, used for bearer token authenticaiton. Do not include 'Bearer ' prefix.</li>\n<li><code>ca_cert</code>: Optional CA certificate file path, used for bearer token authenticaiton.</li>\n<li><code>incuster</code>: Default False. Indicates if used from within k8s cluster. Overrides kubeconfig.</li>\n<li><code>cert_validation</code>: Default True. Can be set to False for self-signed certificates.</li>\n</ul>\n<p>Environment variables:</p>\n<ul>\n<li>INIT_FOR_LIBDOC_ONLY: Set to '1' to generate keyword documentation and skip to load a kube config..</li>\n</ul>", "shortdoc": "KubeLibrary can be configured with several optional arguments. - ``kube_config``:   Path pointing to kubeconfig of target Kubernetes cluster. - ``context``:   Active context. If None current_context from kubeconfig is used. - ``api_url``:   K8s API url, used for bearer token authenticaiton. - ``bearer_token``:   Bearer token, used for bearer token authenticaiton. Do not include 'Bearer ' prefix. - ``ca_cert``:   Optional CA certificate file path, used for bearer token authenticaiton. - ``incuster``:   Default False. Indicates if used from within k8s cluster. Overrides kubeconfig. - ``cert_validation``:   Default True. Can be set to False for self-signed certificates.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 72}], "keywords": [{"name": "Assert Container Has Env Vars", "args": [{"name": "container", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "container"}, {"name": "env_vars_json", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "env_vars_json"}], "doc": "<p>Assert container has env vars.</p>\n<p>Returns True/False</p>\n<ul>\n<li><code>container</code>: Container object.</li>\n<li><code>env_var_json</code>: JSON representing env vars i.e.: {\"EXAMPLE_VAR\": \"examplevalue\"}</li>\n</ul>", "shortdoc": "Assert container has env vars.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 871}, {"name": "Assert Pod Has Annotations", "args": [{"name": "pod", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "pod"}, {"name": "annotations_json", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "annotations_json"}], "doc": "<p>Assert pod has annotations.</p>\n<p>Returns True/False</p>\n<ul>\n<li><code>pod</code>: Pod object.</li>\n<li><code>annotations_json</code>: JSON representing annotations</li>\n</ul>", "shortdoc": "Assert pod has annotations.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 845}, {"name": "Assert Pod Has Labels", "args": [{"name": "pod", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "pod"}, {"name": "labels_json", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "labels_json"}], "doc": "<p>Assert pod has labels.</p>\n<p>Returns True/False</p>\n<ul>\n<li><code>pod</code>: Pod object.</li>\n<li><code>labels_json</code>: JSON representing labels</li>\n</ul>", "shortdoc": "Assert pod has labels.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 819}, {"name": "Create", "args": [{"name": "api_version", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "api_version"}, {"name": "kind", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "kind"}, {"name": "kwargs", "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<p>Creates resource instances based on the provided configuration.</p>\n<p>If the resource is namespaced (ie, not cluster-level), then one of <code>namespace</code>, <code>label_selector</code>, or <code>field_selector</code> is required. If the resource is cluster-level, then one of <code>name</code>, <code>label_selector</code>, or <code>field_selector</code> is required. Can be optionally given a kubernetes manifest (<code>body</code>) which respects the above considerations.</p>\n<ul>\n<li><code>api_version</code>: Api version of the desired kubernetes resource</li>\n<li><code>kind</code>: Kind of the desired kubernetes resource</li>\n<li><code>**kwargs</code>: Keyword arguments for argument forwarding</li>\n</ul>", "shortdoc": "Creates resource instances based on the provided configuration.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 154}, {"name": "Create Cron Job In Namespace", "args": [{"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "body", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "body"}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use create_namespaced_cron_job.</p>\n<p>Creates cron_job in a namespace</p>\n<p>Returns created cron_job</p>\n<ul>\n<li><code>body</code>: Cron_job object.</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use create_namespaced_cron_job.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 1595}, {"name": "Create Namespaced Cron Job", "args": [{"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "body", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "body"}], "doc": "<p>Creates cron_job in a namespace</p>\n<p>Returns created cron_job</p>\n<ul>\n<li><code>body</code>: Cron_job object.</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Creates cron_job in a namespace", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 1583}, {"name": "Create Namespaced Service Account", "args": [{"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "body", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "body"}], "doc": "<p>Creates service account in a namespace</p>\n<p>Returns created service account</p>\n<ul>\n<li><code>body</code>: Service Account object.</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Creates service account in a namespace", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 1122}, {"name": "Create Service Account In Namespace", "args": [{"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "body", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "body"}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use create_namespaced_service_account.</p>\n<p>Creates service account in a namespace</p>\n<p>Returns created service account</p>\n<ul>\n<li><code>body</code>: Service Account object.</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use create_namespaced_service_account.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 1135}, {"name": "Delete", "args": [{"name": "api_version", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "api_version"}, {"name": "kind", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "kind"}, {"name": "kwargs", "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<p>Deletes resource instances based on the provided configuration.</p>\n<p>Can be optionally given a <code>namespace</code>, <code>name</code>, <code>label_selector</code>, <code>body</code> and <code>field_selector</code>.</p>\n<ul>\n<li><code>api_version</code>: Api version of the desired kubernetes resource</li>\n<li><code>kind</code>: Kind of the desired kubernetes resource</li>\n<li><code>**kwargs</code>: Keyword arguments for argument forwarding</li>\n</ul>", "shortdoc": "Deletes resource instances based on the provided configuration.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 171}, {"name": "Delete Cron Job In Namespace", "args": [{"name": "name", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use delete_namespaced_cron_job.</p>\n<p>Deletes cron_job in a namespace</p>\n<p>Returns V1 status</p>\n<ul>\n<li><code>name</code>: Cron Job name</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use delete_namespaced_cron_job.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 1621}, {"name": "Delete Namespaced Cron Job", "args": [{"name": "name", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p>Deletes cron_job in a namespace</p>\n<p>Returns V1 status</p>\n<ul>\n<li><code>name</code>: Cron Job name</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Deletes cron_job in a namespace", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 1609}, {"name": "Delete Namespaced Service Account", "args": [{"name": "name", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p>Deletes service account in a namespace</p>\n<p>Returns V1status</p>\n<ul>\n<li><code>name</code>: Service Account name</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Deletes service account in a namespace", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 1150}, {"name": "Delete Service Account In Namespace", "args": [{"name": "name", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use delete_namespaced_service_account.</p>\n<p>Deletes service account in a namespace</p>\n<p>Returns V1status</p>\n<ul>\n<li><code>name</code>: Service Account name</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use delete_namespaced_service_account.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 1164}, {"name": "Evaluate Callable From K8s Client", "args": [{"name": "attr_name", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "attr_name"}, {"name": "args", "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*args"}, {"name": "kwargs", "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<p>Evaluates a callable from kubernetes client.</p>\n<p>Returns the output of the client callable.</p>\n<ul>\n<li><code>attr_name</code>: Callable name</li>\n<li><code>*args</code>: Positional arguments for argument forwarding</li>\n<li><code>**kwargs</code>: Keyword arguments for argument forwarding</li>\n</ul>", "shortdoc": "Evaluates a callable from kubernetes client.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 111}, {"name": "Filter By Key", "args": [{"name": "objects", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "objects"}, {"name": "key", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key"}, {"name": "match", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "match"}], "doc": "<p>Filter object with key matching value for list of k8s objects.</p>\n<p>Returns list of objects.</p>\n<ul>\n<li><code>objects</code>: List of k8s objects</li>\n<li><code>key</code>: Key to match</li>\n<li><code>match</code>: Value of the key based on which objects will be included</li>\n</ul>", "shortdoc": "Filter object with key matching value for list of k8s objects.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 671}, {"name": "Filter Configmap Names", "args": [{"name": "configmaps", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "configmaps"}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. See examples in TBD. Filter configmap  names for list of configmaps. Returns list of strings.</p>\n<ul>\n<li><code>configmaps</code>: List of configmap objects</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. See examples in TBD. Filter configmap  names for list of configmaps. Returns list of strings. - ``configmaps``:   List of configmap objects", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 723}, {"name": "Filter Containers Images", "args": [{"name": "containers", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "containers"}], "doc": "<p>Filters container images for given lists of containers.</p>\n<p>Returns list of images.</p>\n<ul>\n<li><code>containers</code>: List of containers</li>\n</ul>", "shortdoc": "Filters container images for given lists of containers.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 758}, {"name": "Filter Containers Resources", "args": [{"name": "containers", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "containers"}], "doc": "<p>Filters container resources for given lists of containers.</p>\n<p>Returns list of resources.</p>\n<ul>\n<li><code>containers</code>: List of containers</li>\n</ul>", "shortdoc": "Filters container resources for given lists of containers.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 769}, {"name": "Filter Deployments Names", "args": [{"name": "deployments", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "deployments"}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. See examples in TBD. Returns list of strings.</p>\n<ul>\n<li><code>deployments</code>: List of deployments objects</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. See examples in TBD. Returns list of strings. - ``deployments``:   List of deployments objects", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 685}, {"name": "Filter Endpoints Names", "args": [{"name": "endpoints", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "endpoints"}], "doc": "<p>Filter endpoints names for list of endpoints. Returns list of strings.</p>\n<ul>\n<li><code>endpoints</code>:</li>\n</ul>\n<p>List of endpoint objects</p>", "shortdoc": "Filter endpoints names for list of endpoints. Returns list of strings. - ``endpoints``: List of endpoint objects", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 732}, {"name": "Filter Names", "args": [{"name": "objects", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "objects"}], "doc": "<p>Filter .metadata.name for list of k8s objects.</p>\n<p>Returns list of strings.</p>\n<ul>\n<li><code>objects</code>: List of k8s objects</li>\n</ul>", "shortdoc": "Filter .metadata.name for list of k8s objects.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 661}, {"name": "Filter Pods Containers By Name", "args": [{"name": "pods", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "pods"}, {"name": "name_pattern", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name_pattern"}], "doc": "<p>Filters pods containers by name for given list of pods.</p>\n<p>Returns lists of containers (flattens).</p>\n<ul>\n<li><code>pods</code>: List of pods objects</li>\n</ul>", "shortdoc": "Filters pods containers by name for given list of pods.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 741}, {"name": "Filter Pods Containers Statuses By Name", "args": [{"name": "pods", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "pods"}, {"name": "name_pattern", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name_pattern"}], "doc": "<p>Filters pods containers statuses by container name for given list of pods.</p>\n<p>Returns lists of containers statuses.</p>\n<ul>\n<li><code>pods</code>: List of pods objects</li>\n</ul>", "shortdoc": "Filters pods containers statuses by container name for given list of pods.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 780}, {"name": "Filter Pods Names", "args": [{"name": "pods", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "pods"}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. See examples in TBD. Filter pod names for list of pods.</p>\n<p>Returns list of strings.</p>\n<ul>\n<li><code>pods</code>: List of pods objects</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. See examples in TBD. Filter pod names for list of pods.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 701}, {"name": "Filter Replicasets Names", "args": [{"name": "replicasets", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "replicasets"}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. See examples in TBD. Returns list of strings.</p>\n<ul>\n<li><code>replicasets</code>: List of replicasets objects</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. See examples in TBD. Returns list of strings. - ``replicasets``:   List of replicasets objects", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 693}, {"name": "Filter Service Accounts Names", "args": [{"name": "service_accounts", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "service_accounts"}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. See examples in TBD. Filter service accounts names for list of service accounts.</p>\n<p>Returns list of strings.</p>\n<ul>\n<li><code>service_accounts</code>: List of service accounts objects</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. See examples in TBD. Filter service accounts names for list of service accounts.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 712}, {"name": "Generate Alphanumeric Str", "args": [{"name": "size", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "size"}], "doc": "<p>Generates a random alphanumeric string with given size.</p>\n<p>Returns a string.</p>\n<ul>\n<li><code>size</code>: Desired size of the output string</li>\n</ul>", "shortdoc": "Generates a random alphanumeric string with given size.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 100}, {"name": "Get", "args": [{"name": "api_version", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "api_version"}, {"name": "kind", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "kind"}, {"name": "kwargs", "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<p>Retrieves resource instances based on the provided parameters.</p>\n<p>Can be optionally given a <code>namespace</code>, <code>name</code>, <code>label_selector</code>, <code>body</code> and <code>field_selector</code>.</p>\n<p>Returns a resource list.</p>\n<ul>\n<li><code>api_version</code>: Api version of the desired kubernetes resource</li>\n<li><code>kind</code>: Kind of the desired kubernetes resource</li>\n<li><code>**kwargs</code>: Keyword arguments for argument forwarding</li>\n</ul>", "shortdoc": "Retrieves resource instances based on the provided parameters.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 137}, {"name": "Get Cluster Custom Object", "args": [{"name": "group", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "group"}, {"name": "version", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "version"}, {"name": "plural", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "plural"}, {"name": "name", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}], "doc": "<p>Get cluster level custom object.</p>\n<p>Returns an object.</p>\n<ul>\n<li><code>group</code>: API Group, e.g. 'scheduling.k8s.io'</li>\n<li><code>version</code>: API version, e.g. 'v1'</li>\n<li><code>plural</code>: e.g. 'priorityclasses'</li>\n<li><code>name</code>: e.g. 'system-node-critical'</li>\n</ul>\n<p>As in <code>GET /apis/{group}/{version}/{plural}/{name}</code></p>\n<p><a href=\"https://github.com/kubernetes-client/python/blob/master/kubernetes/README.md\">https://github.com/kubernetes-client/python/blob/master/kubernetes/README.md</a></p>", "shortdoc": "Get cluster level custom object.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 1517}, {"name": "Get Cluster Role Bindings", "args": [], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use list_cluster_role_binding.</p>\n<p>Gets a list of cluster_role_bindings.</p>\n<p>Returns list of cluster_role_bindings.</p>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use list_cluster_role_binding.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 1397}, {"name": "Get Cluster Roles", "args": [], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use list_cluster_role.</p>\n<p>Gets a list of cluster_roles.</p>\n<p>Returns list of cluster_roles.</p>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use list_cluster_role.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 1379}, {"name": "Get Configmaps In Namespace", "args": [{"name": "name_pattern", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name_pattern"}, {"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "typedocs": {}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use list_namespaced_config_map_by_pattern. Gets configmaps matching pattern in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of configmaps.</p>\n<ul>\n<li><code>name_pattern</code>: configmap name pattern to check</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use list_namespaced_config_map_by_pattern. Gets configmaps matching pattern in given namespace.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 429}, {"name": "Get Cron Job Details In Namespace", "args": [{"name": "name", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use read_namespaced_cron_job.</p>\n<p>Gets cron job details in given namespace.</p>\n<p>Returns Cron job object representation.</p>\n<ul>\n<li><code>name</code>: Name of cron job.</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use read_namespaced_cron_job.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 1300}, {"name": "Get Cron Jobs In Namespace", "args": [{"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "typedocs": {}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use list_namespaced_cron_job.</p>\n<p>Gets cron jobs in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of strings.</p>\n<ul>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use list_namespaced_cron_job.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 1272}, {"name": "Get Custom Object In Namespace", "args": [{"name": "group", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "group"}, {"name": "version", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "version"}, {"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "plural", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "plural"}, {"name": "name", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use get_namespaced_custom_object.</p>\n<p>Get custom object in namespace.</p>\n<p>Returns an object.</p>\n<ul>\n<li><code>group</code>: API Group, e.g. 'k8s.cni.cncf.io'</li>\n<li><code>version</code>: API version, e.g. 'v1'</li>\n<li><code>namespace</code>: Namespace, e.g. 'default'</li>\n<li><code>plural</code>: e.g. 'network-attachment-definitions'</li>\n<li><code>name</code>: e.g. 'my-network'</li>\n</ul>\n<p>As in <code>GET /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}</code></p>\n<p><a href=\"https://github.com/kubernetes-client/python/blob/master/kubernetes/README.md\">https://github.com/kubernetes-client/python/blob/master/kubernetes/README.md</a></p>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use get_namespaced_custom_object.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 1559}, {"name": "Get Daemonset Details In Namespace", "args": [{"name": "name", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use read_namespaced_daemon_set.</p>\n<p>Gets deamonset details in given namespace.</p>\n<p>Returns daemonset object representation.</p>\n<ul>\n<li><code>name</code>: Name of the daemonset</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use read_namespaced_daemon_set.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 1356}, {"name": "Get Daemonsets In Namespace", "args": [{"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "typedocs": {}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use list_namespaced_daemon_set.</p>\n<p>Gets a list of available daemonsets.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of deaemonsets.</p>\n<ul>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use list_namespaced_daemon_set.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 1328}, {"name": "Get Deployments In Namespace", "args": [{"name": "name_pattern", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name_pattern"}, {"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "typedocs": {}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use list_namespaced_deployment_by_pattern. Gets deployments matching pattern in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of deployments.</p>\n<ul>\n<li><code>name_pattern</code>: deployment name pattern to check</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use list_namespaced_deployment_by_pattern. Gets deployments matching pattern in given namespace.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 499}, {"name": "Get Dynamic Resource", "args": [{"name": "api_version", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "api_version"}, {"name": "kind", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "kind"}], "doc": "<p>Returns a dynamic resource based on the provided api version and kind.</p>\n<ul>\n<li><code>api_version</code>: Api version of the desired kubernetes resource</li>\n<li><code>kind</code>: Kind of the desired kubernetes resource</li>\n</ul>", "shortdoc": "Returns a dynamic resource based on the provided api version and kind.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 127}, {"name": "Get Endpoints In Namespace", "args": [{"name": "name", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use read_namespaced_endpoints.</p>\n<p>Gets endpoint details in given namespace.</p>\n<p>Returns Endpoint object representation. Can be accessed using</p>\n<table border=\"1\">\n<tr>\n<td>Should Match</td>\n<td>${endpoint_details.subsets[0].addresses[0].target_ref.name}</td>\n<td>pod-name-123456</td>\n</tr>\n</table>\n<ul>\n<li><code>name</code>: Name of endpoint.</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use read_namespaced_endpoints.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 1035}, {"name": "Get Healthcheck", "args": [{"name": "endpoint", "types": [], "typedocs": {}, "defaultValue": "/readyz", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "endpoint=/readyz"}, {"name": "verbose", "types": [], "typedocs": {}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "verbose=False"}], "doc": "<p>Performs GET on /readyz or /livez for simple health check.</p>\n<p>Can be used to verify the readiness/current status of the API server Returns tuple of (response data, response status and response headers)</p>\n<ul>\n<li><code>endpoint</code>: /readyz, /livez or induvidual endpoints like '/livez/etcd'. defaults to /readyz</li>\n<li><code>verbose</code>: More detailed output.</li>\n</ul>\n<p><a href=\"https://kubernetes.io/docs/reference/using-api/health-checks\">https://kubernetes.io/docs/reference/using-api/health-checks</a></p>", "shortdoc": "Performs GET on /readyz or /livez for simple health check.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 1180}, {"name": "Get Healthy Nodes Count", "args": [{"name": "label_selector", "types": [], "typedocs": {}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p>Counts node with KubeletReady and status True.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Can be used to check number of healthy nodes. Can be used as prerequisite in tests.</p>", "shortdoc": "Counts node with KubeletReady and status True.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 314}, {"name": "Get Hpa Details In Namespace", "args": [{"name": "name", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use list_namespaced_horizontal_pod_autoscaler.</p>\n<p>Gets Horizontal Pod Autoscaler details in given namespace.</p>\n<p>Returns Horizontal Pod Autoscaler object representation. Can be accessed using</p>\n<table border=\"1\">\n<tr>\n<td>Should Be Equal As integers</td>\n<td>${hpa_details.spec.target_cpu_utilization_percentage}</td>\n<td>50</td>\n</tr>\n</table>\n<ul>\n<li><code>name</code>: Name of Horizontal Pod Autoscaler</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use list_namespaced_horizontal_pod_autoscaler.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 1003}, {"name": "Get Hpas In Namespace", "args": [{"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "typedocs": {}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use list_namespaced_horizontal_pod_autoscaler.</p>\n<p>Gets Horizontal Pod Autoscalers in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of strings.</p>\n<ul>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use list_namespaced_horizontal_pod_autoscaler.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 973}, {"name": "Get Ingress Details In Namespace", "args": [{"name": "name", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use read_namespaced_ingress.</p>\n<p>Gets ingress details in given namespace.</p>\n<p>Returns Ingress object representation. Name of ingress.</p>\n<ul>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use read_namespaced_ingress.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 1246}, {"name": "Get Ingresses In Namespace", "args": [{"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "typedocs": {}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use list_namespaced_ingress.</p>\n<p>Gets ingresses in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value Returns list of strings.</p>\n<ul>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use list_namespaced_ingress.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 1222}, {"name": "Get Jobs In Namespace", "args": [{"name": "name_pattern", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name_pattern"}, {"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "typedocs": {}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use list_namespaced_job_by_pattern. Gets jobs matching pattern in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of jobs.</p>\n<ul>\n<li><code>name_pattern</code>: job name pattern to check</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use list_namespaced_job_by_pattern. Gets jobs matching pattern in given namespace.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 569}, {"name": "Get Kubelet Version", "args": [{"name": "label_selector", "types": [], "typedocs": {}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p>Gets list of kubelet versions on each node.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of strings.</p>", "shortdoc": "Gets list of kubelet versions on each node.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 1112}, {"name": "Get Namespaced Custom Object", "args": [{"name": "group", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "group"}, {"name": "version", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "version"}, {"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "plural", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "plural"}, {"name": "name", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}], "doc": "<p>Get custom object in namespace.</p>\n<p>Returns an object.</p>\n<ul>\n<li><code>group</code>: API Group, e.g. 'k8s.cni.cncf.io'</li>\n<li><code>version</code>: API version, e.g. 'v1'</li>\n<li><code>namespace</code>: Namespace, e.g. 'default'</li>\n<li><code>plural</code>: e.g. 'network-attachment-definitions'</li>\n<li><code>name</code>: e.g. 'my-network'</li>\n</ul>\n<p>As in <code>GET /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}</code></p>\n<p><a href=\"https://github.com/kubernetes-client/python/blob/master/kubernetes/README.md\">https://github.com/kubernetes-client/python/blob/master/kubernetes/README.md</a></p>", "shortdoc": "Get custom object in namespace.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 1537}, {"name": "Get Namespaced Pod Exec", "args": [{"name": "name", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "argv_cmd", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "argv_cmd"}, {"name": "container", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "container=None"}], "doc": "<p>Exec command on selected container for POD.</p>\n<p>Returns command stdout/stderr</p>\n<ul>\n<li><code>name</code>: pod name</li>\n<li><code>namespace</code>: namespace to check</li>\n<li><code>argv_cmd</code>: command to be executed using argv syntax: [\"/bin/sh\", \"-c\", \"ls\"] it do not use shell as default!</li>\n<li><code>container</code>: container on which we run exec, default: None</li>\n</ul>", "shortdoc": "Exec command on selected container for POD.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 622}, {"name": "Get Namespaces", "args": [{"name": "label_selector", "types": [], "typedocs": {}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use list_namespace. Gets a list of available namespaces.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of namespaces names.</p>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use list_namespace. Gets a list of available namespaces.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 304}, {"name": "Get Pod Logs", "args": [{"name": "name", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "container", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "container"}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use read_namespaced_pod_log. Gets container logs of given pod in given namespace.</p>\n<p>Returns logs.</p>\n<ul>\n<li><code>name</code>: Pod name to check</li>\n<li><code>namespace</code>: Namespace to check</li>\n<li><code>container</code>: Container to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use read_namespaced_pod_log. Gets container logs of given pod in given namespace.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 396}, {"name": "Get Pod Names In Namespace", "args": [{"name": "name_pattern", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name_pattern"}, {"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "typedocs": {}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use list_namespaced_pod_by_pattern. Gets pod name matching pattern in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of strings.</p>\n<ul>\n<li><code>name_pattern</code>: Pod name pattern to check</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use list_namespaced_pod_by_pattern. Gets pod name matching pattern in given namespace.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 329}, {"name": "Get Pod Status In Namespace", "args": [{"name": "name", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use read_namespaced_pod_status.</p>\n<ul>\n<li><code>name</code>: Name of pod.</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use read_namespaced_pod_status.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 807}, {"name": "Get Pods In Namespace", "args": [{"name": "name_pattern", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name_pattern"}, {"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "typedocs": {}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use list_namespaced_pod_by_pattern. Gets pods matching pattern in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of pods.</p>\n<ul>\n<li><code>name_pattern</code>: Pod name pattern to check</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use list_namespaced_pod_by_pattern. Gets pods matching pattern in given namespace.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 363}, {"name": "Get Pvc Capacity", "args": [{"name": "name", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use read_namespaced_persistent_volume_claim.</p>\n<p>Gets PVC details in given namespace.</p>\n<p>Returns PVC object representation. Can be accessed using</p>\n<table border=\"1\">\n<tr>\n<td>Should Be Equal As strings</td>\n<td>${pvc.status.capacity.storage}</td>\n<td>1Gi</td>\n</tr>\n</table>\n<ul>\n<li><code>name</code>: Name of PVC.</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use read_namespaced_persistent_volume_claim.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 1095}, {"name": "Get Pvc In Namespace", "args": [{"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "typedocs": {}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use list_namespaced_persistent_volume_claim.</p>\n<p>Gets pvcs in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of strings.</p>\n<ul>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use list_namespaced_persistent_volume_claim.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 1065}, {"name": "Get Replicasets In Namespace", "args": [{"name": "name_pattern", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name_pattern"}, {"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "typedocs": {}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use list_namespaced_replica_set_by_pattern. Gets replicasets matching pattern in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of  replicasets.</p>\n<ul>\n<li><code>name_pattern</code>: replicaset name pattern to check</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use list_namespaced_replica_set_by_pattern. Gets replicasets matching pattern in given namespace.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 534}, {"name": "Get Role Bindings In Namespace", "args": [{"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use list_namespaced_role_binding.</p>\n<p>Gets role_bindings in given namespace.</p>\n<p>Returns list of role_bindings.</p>\n<ul>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use list_namespaced_role_binding.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 1442}, {"name": "Get Roles In Namespace", "args": [{"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use list_namespaced_role.</p>\n<p>Gets roles in given namespace.</p>\n<p>Returns list of roles.</p>\n<ul>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use list_namespaced_role.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 1418}, {"name": "Get Secrets In Namespace", "args": [{"name": "name_pattern", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name_pattern"}, {"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "typedocs": {}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use list_namespaced_secret_by_pattern. Gets secrets matching pattern in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of secrets.</p>\n<ul>\n<li><code>name_pattern</code>: secret name pattern to check</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use list_namespaced_secret_by_pattern. Gets secrets matching pattern in given namespace.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 604}, {"name": "Get Service Accounts In Namespace", "args": [{"name": "name_pattern", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name_pattern"}, {"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "typedocs": {}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use list_namespaced_service_account_by_pattern. Gets service accounts matching pattern in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of service accounts.</p>\n<ul>\n<li><code>name_pattern</code>: Service Account name pattern to check</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use list_namespaced_service_account_by_pattern. Gets service accounts matching pattern in given namespace.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 464}, {"name": "Get Service Details In Namespace", "args": [{"name": "name", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use read_namespaced_service.</p>\n<p>Gets service details in given namespace.</p>\n<p>Returns Service object representation. Can be accessed using</p>\n<table border=\"1\">\n<tr>\n<td>Should Be Equal As integers</td>\n<td>${service_details.spec.ports[0].port}</td>\n<td>8080</td>\n</tr>\n</table>\n<ul>\n<li><code>name</code>: Name of service.</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use read_namespaced_service.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 943}, {"name": "Get Services In Namespace", "args": [{"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "typedocs": {}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use list_namespaced_service.</p>\n<p>Gets services in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of strings.</p>\n<ul>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use list_namespaced_service.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 913}, {"name": "K8s Api Ping", "args": [], "doc": "<p>Performs GET on /api/v1/ for simple check of API availability.</p>\n<p>Returns tuple of (response data, response status, response headers). Can be used as prerequisite in tests.</p>", "shortdoc": "Performs GET on /api/v1/ for simple check of API availability.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 275}, {"name": "List Cluster Custom Definition", "args": [{"name": "label_selector", "types": [], "typedocs": {}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}, {"name": "field_selector", "types": [], "typedocs": {}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "field_selector="}], "doc": "<p>Lists Custom Resource Definitions.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value Can be optionally filtered by field. e.g. field_selector=label_key=label_value</p>\n<p>Returns list of CRD's.</p>\n<p><a href=\"https://github.com/kubernetes-client/python/blob/master/kubernetes/README.md\">https://github.com/kubernetes-client/python/blob/master/kubernetes/README.md</a></p>", "shortdoc": "Lists Custom Resource Definitions.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 1455}, {"name": "List Cluster Custom Object", "args": [{"name": "group", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "group"}, {"name": "version", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "version"}, {"name": "plural", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "plural"}], "doc": "<p>Lists cluster level custom objects.</p>\n<p>Returns an object.</p>\n<ul>\n<li><code>group</code>: API Group, e.g. 'k8s.cni.cncf.io'</li>\n<li><code>version</code>: API version, e.g. 'v1'</li>\n<li><code>plural</code>: e.g. 'network-attachment-definitions'</li>\n</ul>\n<p>As in <code>GET /apis/{group}/{version}/{plural}</code></p>\n<p><a href=\"https://github.com/kubernetes-client/python/blob/master/kubernetes/README.md\">https://github.com/kubernetes-client/python/blob/master/kubernetes/README.md</a></p>", "shortdoc": "Lists cluster level custom objects.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 1479}, {"name": "List Cluster Custom Objects", "args": [{"name": "group", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "group"}, {"name": "version", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "version"}, {"name": "plural", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "plural"}], "doc": "<p><b>DEPRECATED</b> Will be removed in v1.0.0. Use list_cluster_custom_object.</p>\n<p>Lists cluster level custom objects.</p>\n<p>Returns an object.</p>\n<ul>\n<li><code>group</code>: API Group, e.g. 'k8s.cni.cncf.io'</li>\n<li><code>version</code>: API version, e.g. 'v1'</li>\n<li><code>plural</code>: e.g. 'network-attachment-definitions'</li>\n</ul>\n<p>As in <code>GET /apis/{group}/{version}/{plural}</code></p>\n<p><a href=\"https://github.com/kubernetes-client/python/blob/master/kubernetes/README.md\">https://github.com/kubernetes-client/python/blob/master/kubernetes/README.md</a></p>", "shortdoc": "*DEPRECATED* Will be removed in v1.0.0. Use list_cluster_custom_object.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 1497}, {"name": "List Cluster Role", "args": [], "doc": "<p>Gets a list of cluster_roles.</p>\n<p>Returns list of cluster_roles.</p>", "shortdoc": "Gets a list of cluster_roles.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 1371}, {"name": "List Cluster Role Binding", "args": [], "doc": "<p>Gets a list of cluster_role_bindings.</p>\n<p>Returns list of cluster_role_bindings.</p>", "shortdoc": "Gets a list of cluster_role_bindings.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 1389}, {"name": "List Namespace", "args": [{"name": "label_selector", "types": [], "typedocs": {}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p>Lists available namespaces.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of namespaces.</p>", "shortdoc": "Lists available namespaces.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 294}, {"name": "List Namespaced Config Map By Pattern", "args": [{"name": "name_pattern", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name_pattern"}, {"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "typedocs": {}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p>Lists configmaps matching pattern in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of configmaps.</p>\n<ul>\n<li><code>name_pattern</code>: configmap name pattern to check</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Lists configmaps matching pattern in given namespace.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 412}, {"name": "List Namespaced Cron Job", "args": [{"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "typedocs": {}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p>Gets cron jobs in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of strings.</p>\n<ul>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Gets cron jobs in given namespace.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 1259}, {"name": "List Namespaced Daemon Set", "args": [{"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "typedocs": {}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p>Gets a list of available daemonsets.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of deaemonsets.</p>\n<ul>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Gets a list of available daemonsets.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 1315}, {"name": "List Namespaced Deployment By Pattern", "args": [{"name": "name_pattern", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name_pattern"}, {"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "typedocs": {}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p>Gets deployments matching pattern in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of deployments.</p>\n<ul>\n<li><code>name_pattern</code>: deployment name pattern to check</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Gets deployments matching pattern in given namespace.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 482}, {"name": "List Namespaced Horizontal Pod Autoscaler", "args": [{"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "typedocs": {}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p>Gets Horizontal Pod Autoscalers in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of strings.</p>\n<ul>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Gets Horizontal Pod Autoscalers in given namespace.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 960}, {"name": "List Namespaced Ingress", "args": [{"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "typedocs": {}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p>Gets ingresses in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value Returns list of strings.</p>\n<ul>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Gets ingresses in given namespace.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 1211}, {"name": "List Namespaced Job By Pattern", "args": [{"name": "name_pattern", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name_pattern"}, {"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "typedocs": {}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p>Gets jobs matching pattern in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of jobs.</p>\n<ul>\n<li><code>name_pattern</code>: job name pattern to check</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Gets jobs matching pattern in given namespace.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 552}, {"name": "List Namespaced Persistent Volume Claim", "args": [{"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "typedocs": {}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p>Gets pvcs in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of strings.</p>\n<ul>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Gets pvcs in given namespace.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 1052}, {"name": "List Namespaced Pod By Pattern", "args": [{"name": "name_pattern", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name_pattern"}, {"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "typedocs": {}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p>List pods matching pattern in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of pods.</p>\n<ul>\n<li><code>name_pattern</code>: Pod name pattern to check</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "List pods matching pattern in given namespace.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 346}, {"name": "List Namespaced Replica Set By Pattern", "args": [{"name": "name_pattern", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name_pattern"}, {"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "typedocs": {}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p>Lists replicasets matching pattern in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of  replicasets.</p>\n<ul>\n<li><code>name_pattern</code>: replicaset name pattern to check</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Lists replicasets matching pattern in given namespace.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 517}, {"name": "List Namespaced Role", "args": [{"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p>Gets roles in given namespace.</p>\n<p>Returns list of roles.</p>\n<ul>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Gets roles in given namespace.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 1407}, {"name": "List Namespaced Role Binding", "args": [{"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p>Gets role_bindings in given namespace.</p>\n<p>Returns list of role_bindings.</p>\n<ul>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Gets role_bindings in given namespace.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 1431}, {"name": "List Namespaced Secret By Pattern", "args": [{"name": "name_pattern", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name_pattern"}, {"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "typedocs": {}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p>Lists secrets matching pattern in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of secrets.</p>\n<ul>\n<li><code>name_pattern</code>: secret name pattern to check</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Lists secrets matching pattern in given namespace.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 587}, {"name": "List Namespaced Service", "args": [{"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "typedocs": {}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p>Gets services in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of strings.</p>\n<ul>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Gets services in given namespace.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 900}, {"name": "List Namespaced Service Account By Pattern", "args": [{"name": "name_pattern", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name_pattern"}, {"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "label_selector", "types": [], "typedocs": {}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "label_selector="}], "doc": "<p>Lists service accounts matching pattern in given namespace.</p>\n<p>Can be optionally filtered by label. e.g. label_selector=label_key=label_value</p>\n<p>Returns list of service accounts.</p>\n<ul>\n<li><code>name_pattern</code>: Service Account name pattern to check</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Lists service accounts matching pattern in given namespace.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 447}, {"name": "Patch", "args": [{"name": "api_version", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "api_version"}, {"name": "kind", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "kind"}, {"name": "kwargs", "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<p>Patches resource instances based on the provided parameters.</p>\n<p>Can be optionally given a <code>namespace</code>, <code>name</code>, <code>label_selector</code>, <code>body</code> and <code>field_selector</code>.</p>\n<ul>\n<li><code>api_version</code>: Api version of the desired kubernetes resource</li>\n<li><code>kind</code>: Kind of the desired kubernetes resource</li>\n<li><code>**kwargs</code>: Keyword arguments for argument forwarding</li>\n</ul>", "shortdoc": "Patches resource instances based on the provided parameters.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 186}, {"name": "Read Cluster Custom Definition", "args": [{"name": "name", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}], "doc": "<p>Reads the specified CustomResourceDefinition.</p>\n<p>Returns an object.</p>\n<ul>\n<li><code>name</code>: Custom Resource Definition name, e.g. 'repos.configmanagement.gke.io'</li>\n</ul>\n<p><a href=\"https://github.com/kubernetes-client/python/blob/master/kubernetes/README.md\">https://github.com/kubernetes-client/python/blob/master/kubernetes/README.md</a></p>", "shortdoc": "Reads the specified CustomResourceDefinition.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 1467}, {"name": "Read Namespaced Cron Job", "args": [{"name": "name", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p>Gets cron job details in given namespace.</p>\n<p>Returns Cron job object representation.</p>\n<ul>\n<li><code>name</code>: Name of cron job.</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Gets cron job details in given namespace.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 1287}, {"name": "Read Namespaced Daemon Set", "args": [{"name": "name", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p>Gets deamonset details in given namespace.</p>\n<p>Returns daemonset object representation.</p>\n<ul>\n<li><code>name</code>: Name of the daemonset</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Gets deamonset details in given namespace.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 1343}, {"name": "Read Namespaced Endpoints", "args": [{"name": "name", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p>Gets endpoint details in given namespace.</p>\n<p>Returns Endpoint object representation. Can be accessed using</p>\n<table border=\"1\">\n<tr>\n<td>Should Match</td>\n<td>${endpoint_details.subsets[0].addresses[0].target_ref.name}</td>\n<td>pod-name-123456</td>\n</tr>\n</table>\n<ul>\n<li><code>name</code>: Name of endpoint.</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Gets endpoint details in given namespace.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 1020}, {"name": "Read Namespaced Horizontal Pod Autoscaler", "args": [{"name": "name", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p>Gets Horizontal Pod Autoscaler details in given namespace.</p>\n<p>Returns Horizontal Pod Autoscaler object representation. Can be accessed using</p>\n<table border=\"1\">\n<tr>\n<td>Should Be Equal As integers</td>\n<td>${hpa_details.spec.target_cpu_utilization_percentage}</td>\n<td>50</td>\n</tr>\n</table>\n<ul>\n<li><code>name</code>: Name of Horizontal Pod Autoscaler</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Gets Horizontal Pod Autoscaler details in given namespace.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 988}, {"name": "Read Namespaced Ingress", "args": [{"name": "name", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p>Gets ingress details in given namespace.</p>\n<p>Returns Ingress object representation. Name of ingress.</p>\n<ul>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Gets ingress details in given namespace.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 1235}, {"name": "Read Namespaced Persistent Volume Claim", "args": [{"name": "name", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p>Gets PVC details in given namespace.</p>\n<p>Returns PVC object representation. Can be accessed using</p>\n<table border=\"1\">\n<tr>\n<td>Should Be Equal As strings</td>\n<td>${pvc.status.capacity.storage}</td>\n<td>1Gi</td>\n</tr>\n</table>\n<ul>\n<li><code>name</code>: Name of PVC.</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Gets PVC details in given namespace.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 1080}, {"name": "Read Namespaced Pod Log", "args": [{"name": "name", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}, {"name": "container", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "container"}], "doc": "<p>Gets container logs of given pod in given namespace.</p>\n<p>Returns logs.</p>\n<ul>\n<li><code>name</code>: Pod name to check</li>\n<li><code>namespace</code>: Namespace to check</li>\n<li><code>container</code>: Container to check</li>\n</ul>", "shortdoc": "Gets container logs of given pod in given namespace.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 381}, {"name": "Read Namespaced Pod Status", "args": [{"name": "name", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p>Reads pod status in given namespace.</p>\n<ul>\n<li><code>name</code>: Name of pod.</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Reads pod status in given namespace.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 796}, {"name": "Read Namespaced Service", "args": [{"name": "name", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}, {"name": "namespace", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "namespace"}], "doc": "<p>Gets service details in given namespace.</p>\n<p>Returns Service object representation. Can be accessed using</p>\n<table border=\"1\">\n<tr>\n<td>Should Be Equal As integers</td>\n<td>${service_details.spec.ports[0].port}</td>\n<td>8080</td>\n</tr>\n</table>\n<ul>\n<li><code>name</code>: Name of service.</li>\n<li><code>namespace</code>: Namespace to check</li>\n</ul>", "shortdoc": "Gets service details in given namespace.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 928}, {"name": "Reload Config", "args": [{"name": "kube_config", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "kube_config=None"}, {"name": "context", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "context=None"}, {"name": "api_url", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "api_url=None"}, {"name": "bearer_token", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "bearer_token=None"}, {"name": "ca_cert", "types": [], "typedocs": {}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "ca_cert=None"}, {"name": "incluster", "types": [], "typedocs": {}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "incluster=False"}, {"name": "cert_validation", "types": [], "typedocs": {}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "cert_validation=True"}], "doc": "<p>Reload the KubeLibrary to be configured with different optional arguments. This can be used to connect to a different cluster during the same test.</p>\n<ul>\n<li><code>kube_config</code>: Path pointing to kubeconfig of target Kubernetes cluster.</li>\n<li><code>context</code>: Active context. If None current_context from kubeconfig is used.</li>\n<li><code>api_url</code>: K8s API url, used for bearer token authenticaiton.</li>\n<li><code>bearer_token</code>: Bearer token, used for bearer token authenticaiton. Do not include 'Bearer ' prefix.</li>\n<li><code>ca_cert</code>: Optional CA certificate file path, used for bearer token authenticaiton.</li>\n<li><code>incuster</code>: Default False. Indicates if used from within k8s cluster. Overrides kubeconfig.</li>\n<li><code>cert_validation</code>: Default True. Can be set to False for self-signed certificates.</li>\n</ul>", "shortdoc": "Reload the KubeLibrary to be configured with different optional arguments.    This can be used to connect to a different cluster during the same test. - ``kube_config``:   Path pointing to kubeconfig of target Kubernetes cluster. - ``context``:   Active context. If None current_context from kubeconfig is used. - ``api_url``:   K8s API url, used for bearer token authenticaiton. - ``bearer_token``:   Bearer token, used for bearer token authenticaiton. Do not include 'Bearer ' prefix. - ``ca_cert``:   Optional CA certificate file path, used for bearer token authenticaiton. - ``incuster``:   Default False. Indicates if used from within k8s cluster. Overrides kubeconfig. - ``cert_validation``:   Default True. Can be set to False for self-signed certificates.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 216}, {"name": "Replace", "args": [{"name": "api_version", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "api_version"}, {"name": "kind", "types": [], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "kind"}, {"name": "kwargs", "types": [], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs"}], "doc": "<p>Replaces resource instances based on the provided parameters.</p>\n<p>Can be optionally given a <code>namespace</code>, <code>name</code>, <code>label_selector</code>, <code>body</code> and <code>field_selector</code>.</p>\n<ul>\n<li><code>api_version</code>: Api version of the desired kubernetes resource</li>\n<li><code>kind</code>: Kind of the desired kubernetes resource</li>\n<li><code>**kwargs</code>: Keyword arguments for argument forwarding</li>\n</ul>", "shortdoc": "Replaces resource instances based on the provided parameters.", "tags": [], "source": "/Users/raymond/contribution/KubeLibrary/src/KubeLibrary/KubeLibrary.py", "lineno": 201}], "dataTypes": {"enums": [], "typedDicts": []}, "typedocs": []}
 </script>
 <title></title>
 </head>
@@ -1123,44 +1213,29 @@ <h1>Opening library documentation failed</h1>
     window.addEventListener("hashchange", function() {
       document.getElementsByClassName("hamburger-menu")[0].checked = false;
     }, false);
+    window.addEventListener("hashchange", function() {
+        if (window.location.hash.indexOf('#type-') == 0) {
+            const hash = '#' + decodeURI(window.location.hash.slice(6));
+            const typeDoc = document.querySelector(".data-types").querySelector(hash);
+            if (typeDoc) {
+              showModal(typeDoc);
+            }
+        }
+    }, false);
 </script>
 
 <script type="text/javascript">
 
-    function linkArgs(container, dataTypes, usageName) {
-      container.forEach(function(keyword) {
-        let user = usageName || keyword.name
-          keyword.args.forEach(function (arg) {
-            arg.linked = arg.types.filter(function(value) {
-              return dataTypes.filter(function (dataType) {
-                 if (dataType.name === value) {
-                   if (dataType.usage.indexOf(user) === -1) {
-                    dataType.usage.push(user);
-                   }
-                   return true;
-                 }
-                 return false;
-              })[0];
-            });
-          })
-        }
-      );
-    }
-
     $(document).ready(function() {
         parseTemplates();
         document.title = libdoc.name;
         storage.init('libdoc');
-        libdoc.dataTypes = libdoc.dataTypes.enums.concat(libdoc.dataTypes.typedDicts);
-        libdoc.dataTypes = libdoc.dataTypes.map(function(dt) {
-          dt.usage = [];
-          return dt;
-        })
-        libdoc.dataTypes.sort(compare)
-        linkArgs(libdoc.inits, libdoc.dataTypes, "Importing");
-        linkArgs(libdoc.keywords, libdoc.dataTypes);
         renderTemplate('base', libdoc, $('body'));
         if (libdoc.inits.length) {
+            libdoc.typedocs.map(function(type) {
+                var index = type.usages.indexOf('__init__');
+                if (index != -1) type.usages[index] = 'Importing';
+            });
             renderTemplate('importing', libdoc);
         }
         renderTemplate('shortcuts', libdoc);
@@ -1185,18 +1260,9 @@ <h1>Opening library documentation failed</h1>
             openKeywordWall();
           }
       }, 0);
+        createModal();
     });
 
-     function compare( a, b ) {
-      if ( a.name < b.name ){
-        return -1;
-      }
-      if ( a.name > b.name ){
-        return 1;
-      }
-      return 0;
-    }
-
     function parseTemplates() {
         $('script[type="text/x-jquery-tmpl"]').map(function (idx, elem) {
             $.template(elem.id, elem.text);
@@ -1371,12 +1437,81 @@ <h1>Opening library documentation failed</h1>
             renderTemplate('tags', libdoc);
         }
         document.getElementById("keyword-statistics-header").innerText = ''+libdoc.keywords.length;
-        if (libdoc.dataTypes.length) {
-          document.getElementById("type-statistics-header").innerText = '' + libdoc.dataTypes.length;
+        if (libdoc.typedocs.length) {
+            document.getElementById("type-statistics-header").innerText = '' + libdoc.typedocs.length;
         }
         history.replaceState && history.replaceState(null, '', location.pathname);
     }
 
+    function createModal() {
+        const modalBackground = document.createElement('div');
+        modalBackground.id = 'modal-background';
+        modalBackground.classList.add('modal-background');
+        modalBackground.addEventListener('click', ({ target }) => {
+            if (target.id === 'modal-background') hideModal()
+        })
+
+        const modalCloseButton = document.createElement('button');
+        modalCloseButton.innerHTML = `<svg xmlns="
+      http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="2em" height="2em" className="block" data-v-2754030d="" data-v-512b0344="">
+              <path d="M19 6.41L17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"
+                    data-v-2754030d="" fill="var(--text-color)"></path></svg>`;
+        modalCloseButton.classList.add('modal-close-button');
+        const modalCloseButtonContainer = document.createElement('div');
+        modalCloseButtonContainer.classList.add('modal-close-button-container');
+        modalCloseButtonContainer.appendChild(modalCloseButton);
+        modalCloseButton.addEventListener('click', () => {
+            hideModal()
+        })
+        modalBackground.appendChild(modalCloseButtonContainer);
+        modalCloseButtonContainer.addEventListener('click', () => {
+            hideModal()
+        })
+
+        const modal = document.createElement('div');
+        modal.id = 'modal';
+        modal.classList.add('modal');
+        modal.addEventListener('click', ({ target }) => {
+            if (target.tagName.toUpperCase() === 'A') hideModal()
+        })
+
+
+        const modalContent = document.createElement('div');
+        modalContent.id = 'modal-content';
+        modalContent.classList.add('modal-content');
+        modal.appendChild(modalContent);
+
+        modalBackground.appendChild(modal);
+        document.body.appendChild(modalBackground);
+        document.addEventListener('keydown', ({ key }) => {
+            if (key === 'Escape') hideModal()
+        })
+    }
+    function showModal(content) {
+        const modalBackground = document.getElementById('modal-background');
+        const modal = document.getElementById('modal');
+        const modalContent = document.getElementById('modal-content');
+        modalBackground.classList.add('visible');
+        modal.classList.add('visible');
+        modalContent.appendChild(content.cloneNode(true));
+        document.body.style.overflow = 'hidden';
+    }
+    function hideModal() {
+        const modalBackground = document.getElementById('modal-background');
+        const modal = document.getElementById('modal');
+        const modalContent = document.getElementById('modal-content');
+
+        modalBackground.classList.remove('visible');
+        modal.classList.remove('visible');
+        document.body.style.overflow = 'auto';
+        if (window.location.hash.indexOf('#type-') == 0)
+            history.pushState("", document.title, window.location.pathname);
+        // modal is hidden with a fading transition, timeout prevents premature emptying of modal
+        setTimeout(() => {
+            modalContent.innerHTML = '';
+        }, 200);
+    }
+
     // http://stackoverflow.com/a/18484799
     var delay = (function () {
         var timer = 0;
@@ -1385,7 +1520,6 @@ <h1>Opening library documentation failed</h1>
             timer = setTimeout(callback, ms);
         };
     })();
-
 </script>
 
 <script type="text/x-jquery-tmpl" id="base-template">
@@ -1599,34 +1733,43 @@ <h4>Documentation</h4>
 {{/if}}
 
 {{if types.length}}
-  <span class="arg-type" title="Argument '${name}' will be converter to type ${types}">
-    ${( $data.linked = linked ),''}
-    {{each types}}&lt;{{if $data.linked.indexOf($value) > -1}}<a class="type" href="#${$value}">${$value}</a>{{else}}<span class="type">${$value}</span>{{/if}}&gt;<span class="or"></span>{{/each}}
+  <span class="arg-type">
+    {{each types}}
+      {{if $value in $data.typedocs}}
+          &lt;<a style="cursor: pointer;" class="type" title="Click to show type information" onclick="showModal(${$data.typedocs[$value]})">${$value}</a>&gt;
+      {{else}}
+          &lt;<span class="type">${$value}</span>&gt;
+      {{/if}}
+      <span class="or"></span>
+    {{/each}}
   </span>
 {{/if}}
 </script>
 
 
 <script type="text/x-jquery-tmpl" id="data-types-template">
-    {{if dataTypes.length}}
+  {{if typedocs.length}}
     <h2 id="Data types">Data types</h2>
     <div class="data-types">
-        {{each dataTypes}}
+      {{each typedocs}}
         {{tmpl($value) 'data-type-template'}}
-        {{/each}}
+      {{/each}}
     </div>
-    {{/if}}
+  {{/if}}
 </script>
 
 <script type="text/x-jquery-tmpl" id="data-type-template">
     <div class="data-type-container {{if hidden}}no-{{/if}}match" id="${name}">
        <div class="data-type-name">
-            <h2>Type:
-            <a class="dt-name" href="#${encodeURIComponent(name)}"
-               title="Link to this data type">${name}</a>
-            </h2>
+            <h2>${name} (${type})</h2>
        </div>
        <div class="data-type-content">
+          {{if doc}}
+            <div class="dt-docs">
+              <h4>Documentation</h4>
+              <div class="dtdoc doc">{{html doc}}</div>
+            </div>
+          {{/if}}
           {{if members}}
             <div class="dt-members">
               <h4>Allowed Values</h4>
@@ -1634,6 +1777,9 @@ <h4>Allowed Values</h4>
                 {{each members}}
                 <li>
                   <span class="enum-member">${$value.name}</span>
+                  {{if accepts.indexOf("integer") != -1}}
+                    &nbsp; (<span class="enum-member">${$value.value}</span>)
+                  {{/if}}
                 </li>
                 {{/each}}
               </ul>
@@ -1655,20 +1801,22 @@ <h4>Dictionary Structure</h4>
                 </div>
             </div>
           {{/if}}
-          {{if doc}}
+          {{if accepts.length}}
             <div class="dt-docs">
-              <h4>Documentation</h4>
-              <div class="dtdoc doc">{{html doc}}</div>
+              <h4>Converted Types</h4>
+              <ul class="dt-usages-list">
+              {{each accepts}}
+                <li>${$value}</li>
+              {{/each}}
+              </ul>
             </div>
           {{/if}}
-          {{if usage}}
-            <div class="dt-usage">
-              <h4>Used in</h4>
-              <ul class="dt-usage-list">
-                {{each usage}}
-                <li>
-                <a href="#${encodeURIComponent($value)}">${$value}</a>
-                </li>
+          {{if usages.length}}
+            <div class="dt-usages">
+              <h4>Usages</h4>
+              <ul class="dt-usages-list">
+                {{each usages}}
+                  <li><a href="#${encodeURIComponent($value)}">${$value}</a></li>
                 {{/each}}
               </ul>
             </div>
diff --git a/src/KubeLibrary/KubeLibrary.py b/src/KubeLibrary/KubeLibrary.py
index bf5e0216..a2bc4a25 100755
--- a/src/KubeLibrary/KubeLibrary.py
+++ b/src/KubeLibrary/KubeLibrary.py
@@ -262,6 +262,7 @@ def reload_config(self, kube_config=None, context=None, api_url=None, bearer_tok
         self._add_api('appsv1', client.AppsV1Api)
         self._add_api('batchv1_beta1', client.BatchV1beta1Api)
         self._add_api('custom_object', client.CustomObjectsApi)
+        self._add_api('custom_definition', client.ApiextensionsV1Api)
         self._add_api('rbac_authv1_api', client.RbacAuthorizationV1Api)
         self._add_api('autoscalingv1', client.AutoscalingV1Api)
         self._add_api('dynamic', DynamicClient)
@@ -1451,6 +1452,30 @@ def get_role_bindings_in_namespace(self, namespace):
         ret = self.rbac_authv1_api.list_namespaced_role_binding(namespace, watch=False)
         return [item.metadata.name for item in ret.items]
 
+    def list_cluster_custom_definition(self, label_selector="", field_selector=""):
+        """Lists Custom Resource Definitions.
+
+        Can be optionally filtered by label. e.g. label_selector=label_key=label_value
+        Can be optionally filtered by field. e.g. field_selector=label_key=label_value
+
+        Returns list of CRD's.
+
+        https://github.com/kubernetes-client/python/blob/master/kubernetes/README.md
+        """
+        return self.custom_definition.list_custom_resource_definition(label_selector=label_selector, field_selector=field_selector).items
+
+    def read_cluster_custom_definition(self, name):
+        """Reads the specified CustomResourceDefinition.
+
+        Returns an object.
+
+        - ``name``:
+          Custom Resource Definition name, e.g. 'repos.configmanagement.gke.io'
+
+        https://github.com/kubernetes-client/python/blob/master/kubernetes/README.md
+        """
+        return self.custom_definition.read_custom_resource_definition(name)
+
     def list_cluster_custom_object(self, group, version, plural):
         """Lists cluster level custom objects.
 
diff --git a/test/test_KubeLibrary.py b/test/test_KubeLibrary.py
index 19578c66..a7c635e1 100644
--- a/test/test_KubeLibrary.py
+++ b/test/test_KubeLibrary.py
@@ -263,7 +263,7 @@ def mock_list_namespaced_role_bindings(namespace, watch=False):
 class TestKubeLibrary(unittest.TestCase):
 
     apis = ('v1', 'networkingv1api', 'batchv1', 'appsv1', 'batchv1_beta1',
-            'custom_object', 'rbac_authv1_api', 'autoscalingv1', 'dynamic')
+            'custom_object', 'custom_definition', 'rbac_authv1_api', 'autoscalingv1', 'dynamic')
 
     @responses.activate
     def test_KubeLibrary_inits_from_kubeconfig(self):
@@ -783,3 +783,11 @@ def test_read_namespaced_cron_job(self, mock_lnp):
         cron_job_details2 = kl.get_cron_job_details_in_namespace('hello', 'default')
         self.assertEqual(cron_job_details.items.metadata.labels.TestLabel, cron_job_details2.items.metadata.labels.TestLabel)
         self.assertEqual('mytestlabel', cron_job_details.items.metadata.labels.TestLabel)
+
+    def test_read_cluster_custom_definition(self):
+        pass
+
+    def test_list_cluster_custom_definition(self):
+        kl = KubeLibrary(kube_config='test/resources/k3d')
+        crd = kl.list_cluster_custom_definition()
+
diff --git a/testcases/custom_definition/custom_definitions.robot b/testcases/custom_definition/custom_definitions.robot
new file mode 100644
index 00000000..6417d095
--- /dev/null
+++ b/testcases/custom_definition/custom_definitions.robot
@@ -0,0 +1,15 @@
+*** Settings ***
+Resource          ./custom_definitions_kw.robot
+
+*** Variables ***
+${crds}    repos.configmanagement.gke.io syncs.configmanagement.gke.io
+${crd_name}    repos.configmanagement.gke.io
+
+*** Test Cases ***
+Check All The Custom Resource Definitions Exist
+    [Documentation]    Test all the given Custom Resource Definitions exist.
+    CRD contains: ${crds}
+
+Check The Given Custom Resource Definition Exist
+    [Documentation]    Test the given Custom Resource Definition exists.
+    CRD ${crd_name} exists
diff --git a/testcases/custom_definition/custom_definitions_kw.robot b/testcases/custom_definition/custom_definitions_kw.robot
new file mode 100644
index 00000000..61952df9
--- /dev/null
+++ b/testcases/custom_definition/custom_definitions_kw.robot
@@ -0,0 +1,26 @@
+*** Settings ***
+Library           String
+# For regular execution
+Library           KubeLibrary
+# For incluster execution
+#Library           KubeLibrary    None    True    False
+# For development
+#Library           ../../src/KubeLibrary/KubeLibrary.py  ~/.kube/k3d
+
+*** Keywords ***
+CRD contains: ${crd_names}
+    [Documentation]    Check the given CRD's exist!
+    @{crd_name_list}=    Split String   ${crd_names}    ${SPACE}
+    @{all_crds}=    List Cluster Custom Definition
+    @{all_crd_names}=    Filter Names    ${all_crds}
+    ${crd_num}=    Get Length    ${all_crd_names}
+    Log    \nTotally ${crd_num} CRD(s) have been found.    console=True
+    FOR    ${name}    IN    @{crd_name_list}
+        Should Contain    ${all_crd_names}    ${name}
+    END
+
+CRD ${crd_name} exists
+    [Documentation]    Check the given CRD exit!
+    ${crd_detail}=    Read Cluster Custom Definition    ${crd_name}
+    Should Be Equal    ${crd_detail.kind}    CustomResourceDefinition
+Should Be Equal    ${crd_detail.metadata.name}    ${crd_name}