Merge pull request #5 from sernst/custom-objects

v0.15.0

Author: sernst

contents.rst

@@ -7,6 +7,7 @@ Documentation Contents
   docs/overview
   docs/creating_definitions
   docs/resource_access
+  docs/custom_objects
   docs/versions
   docs/crud
   docs/cli

docs/custom_objects.rst

@@ -0,0 +1,48 @@
+Custom Objects
+==============
+
+Custom objects, which are custom resource definitions not specified by the Kubernetes
+standard API, can be utilized and managed in kuber with the ``custom_v1.CustomObject``
+resource. Any unknown resource definition encountered by Kuber will be assumed to be
+a custom object and loaded as a ``custom_v1.CustomObject``.
+
+For example, given the custom object definition below:
+
+.. code-block:: yaml
+
+  apiVersion: argoproj.io/v1alpha1
+  kind: Workflow
+  metadata:
+    generateName: steps-
+  spec:
+    entrypoint: hello
+    templates:
+    - name: hello
+      steps:
+      - - name: hello
+          template: whalesay
+          arguments:
+            parameters: [{name: message, value: "hello1"}]
+    - name: whalesay
+      inputs:
+        parameters:
+        - name: message
+      container:
+        image: docker/whalesay
+        command: [cowsay]
+        args: ["{{inputs.parameters.message}}"]
+
+this can be loaded into a ``CustomObject`` resource directly:
+
+.. code-block:: python
+
+  import pathlib
+  import yaml
+
+  from kuber.latest import custom_v1
+
+  workflow = typing.cast(
+      custom_v1.CustomObject,
+      kuber.from_yaml_file(directory.joinpath("workflow.yaml"))
+  )
+

docs/modules/kuber.definitions.rst

@@ -0,0 +1,10 @@
+kuber.definitions package
+=========================
+
+Module contents
+---------------
+
+.. automodule:: kuber.definitions
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/modules/kuber.latest.rst

@@ -204,6 +204,14 @@ kuber.latest.core\_v1 module
    :undoc-members:
    :show-inheritance:
 
+kuber.latest.custom\_v1 module
+------------------------------
+
+.. automodule:: kuber.latest.custom_v1
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 kuber.latest.discovery\_v1beta1 module
 --------------------------------------
 

docs/modules/kuber.pre.rst

@@ -204,6 +204,14 @@ kuber.pre.core\_v1 module
    :undoc-members:
    :show-inheritance:
 
+kuber.pre.custom\_v1 module
+---------------------------
+
+.. automodule:: kuber.pre.custom_v1
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 kuber.pre.discovery\_v1beta1 module
 -----------------------------------
 

docs/modules/kuber.rst

@@ -7,6 +7,7 @@ Subpackages
 .. toctree::
    :maxdepth: 4
 
+   kuber.definitions
    kuber.interface
    kuber.latest
    kuber.management
@@ -23,14 +24,6 @@ Subpackages
 Submodules
 ----------
 
-kuber.definitions module
-------------------------
-
-.. automodule:: kuber.definitions
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 kuber.execution module
 ----------------------
 

docs/modules/kuber.tests.scenarios.custom_object.rst

@@ -0,0 +1,21 @@
+kuber.tests.scenarios.custom\_object package
+============================================
+
+Submodules
+----------
+
+kuber.tests.scenarios.custom\_object.test\_custom\_object module
+----------------------------------------------------------------
+
+.. automodule:: kuber.tests.scenarios.custom_object.test_custom_object
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: kuber.tests.scenarios.custom_object
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/modules/kuber.tests.scenarios.rst

@@ -8,6 +8,7 @@ Subpackages
    :maxdepth: 4
 
    kuber.tests.scenarios.cron_suspend
+   kuber.tests.scenarios.custom_object
    kuber.tests.scenarios.custom_resource_definition
    kuber.tests.scenarios.empty_values
    kuber.tests.scenarios.get_containers_from_job

docs/modules/kuber.v1_15.rst

@@ -196,6 +196,14 @@ kuber.v1\_15.core\_v1 module
    :undoc-members:
    :show-inheritance:
 
+kuber.v1\_15.custom\_v1 module
+------------------------------
+
+.. automodule:: kuber.v1_15.custom_v1
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 kuber.v1\_15.events\_v1beta1 module
 -----------------------------------
 

docs/modules/kuber.v1_16.rst

@@ -212,6 +212,14 @@ kuber.v1\_16.core\_v1 module
    :undoc-members:
    :show-inheritance:
 
+kuber.v1\_16.custom\_v1 module
+------------------------------
+
+.. automodule:: kuber.v1_16.custom_v1
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 kuber.v1\_16.discovery\_v1alpha1 module
 ---------------------------------------