docs: update docs

Author: VanillaSpoon

docs/cluster/cluster.html

@@ -116,6 +116,7 @@ <h1 class="title">Module <code>codeflare_sdk.cluster.cluster</code></h1>
         instascale = self.config.instascale
         instance_types = self.config.machine_types
         env = self.config.envs
+        image_pull_secrets = self.config.image_pull_secrets
         return generate_appwrapper(
             name=name,
             namespace=namespace,
@@ -130,6 +131,7 @@ <h1 class="title">Module <code>codeflare_sdk.cluster.cluster</code></h1>
             instascale=instascale,
             instance_types=instance_types,
             env=env,
+            image_pull_secrets=image_pull_secrets,
         )
 
     # creates a new cluster with the provided or default spec
@@ -635,6 +637,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         instascale = self.config.instascale
         instance_types = self.config.machine_types
         env = self.config.envs
+        image_pull_secrets = self.config.image_pull_secrets
         return generate_appwrapper(
             name=name,
             namespace=namespace,
@@ -649,6 +652,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
             instascale=instascale,
             instance_types=instance_types,
             env=env,
+            image_pull_secrets=image_pull_secrets,
         )
 
     # creates a new cluster with the provided or default spec
@@ -930,6 +934,7 @@ <h3>Methods</h3>
     instascale = self.config.instascale
     instance_types = self.config.machine_types
     env = self.config.envs
+    image_pull_secrets = self.config.image_pull_secrets
     return generate_appwrapper(
         name=name,
         namespace=namespace,
@@ -944,6 +949,7 @@ <h3>Methods</h3>
         instascale=instascale,
         instance_types=instance_types,
         env=env,
+        image_pull_secrets=image_pull_secrets,
     )</code></pre>
 </details>
 </dd>
@@ -1036,7 +1042,7 @@ <h3>Methods</h3>
 </details>
 </dd>
 <dt id="codeflare_sdk.cluster.cluster.Cluster.list_jobs"><code class="name flex">
-<span>def <span class="ident">list_jobs</span></span>(<span>self) ‑> List[~T]</span>
+<span>def <span class="ident">list_jobs</span></span>(<span>self) ‑> List</span>
 </code></dt>
 <dd>
 <div class="desc"><p>This method accesses the head ray node in your cluster and lists the running jobs.</p></div>

docs/cluster/config.html

@@ -79,7 +79,8 @@ <h1 class="title">Module <code>codeflare_sdk.cluster.config</code></h1>
     template: str = f&#34;{dir}/templates/base-template.yaml&#34;
     instascale: bool = False
     envs: dict = field(default_factory=dict)
-    image: str = &#34;ghcr.io/foundation-model-stack/base:ray2.1.0-py38-gpu-pytorch1.12.0cu116-20221213-193103&#34;</code></pre>
+    image: str = &#34;ghcr.io/foundation-model-stack/base:ray2.1.0-py38-gpu-pytorch1.12.0cu116-20221213-193103&#34;
+    image_pull_secrets: list = field(default_factory=list)</code></pre>
 </details>
 </section>
 <section>
@@ -93,7 +94,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 <dl>
 <dt id="codeflare_sdk.cluster.config.ClusterConfiguration"><code class="flex name class">
 <span>class <span class="ident">ClusterConfiguration</span></span>
-<span>(</span><span>name: str, namespace: str = None, head_info: list = &lt;factory&gt;, machine_types: list = &lt;factory&gt;, min_cpus: int = 1, max_cpus: int = 1, min_worker: int = 1, max_worker: int = 1, min_memory: int = 2, max_memory: int = 2, gpu: int = 0, template: str = '/home/meyceoz/Documents/codeflare-sdk/src/codeflare_sdk/templates/base-template.yaml', instascale: bool = False, envs: dict = &lt;factory&gt;, image: str = 'ghcr.io/foundation-model-stack/base:ray2.1.0-py38-gpu-pytorch1.12.0cu116-20221213-193103')</span>
+<span>(</span><span>name: str, namespace: str = None, head_info: list = &lt;factory&gt;, machine_types: list = &lt;factory&gt;, min_cpus: int = 1, max_cpus: int = 1, min_worker: int = 1, max_worker: int = 1, min_memory: int = 2, max_memory: int = 2, gpu: int = 0, template: str = '/home/eoingallinagh/Documents/RedHat/codeflare-sdk/src/codeflare_sdk/templates/base-template.yaml', instascale: bool = False, envs: dict = &lt;factory&gt;, image: str = 'ghcr.io/foundation-model-stack/base:ray2.1.0-py38-gpu-pytorch1.12.0cu116-20221213-193103', image_pull_secrets: list = &lt;factory&gt;)</span>
 </code></dt>
 <dd>
 <div class="desc"><p>This dataclass is used to specify resource requirements and other details, and
@@ -102,7 +103,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 <summary>
 <span>Expand source code</span>
 </summary>
-<pre><code class="python">class ClusterConfiguration:
+<pre><code class="python">@dataclass
+class ClusterConfiguration:
     &#34;&#34;&#34;
     This dataclass is used to specify resource requirements and other details, and
     is passed in as an argument when creating a Cluster object.
@@ -122,7 +124,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
     template: str = f&#34;{dir}/templates/base-template.yaml&#34;
     instascale: bool = False
     envs: dict = field(default_factory=dict)
-    image: str = &#34;ghcr.io/foundation-model-stack/base:ray2.1.0-py38-gpu-pytorch1.12.0cu116-20221213-193103&#34;</code></pre>
+    image: str = &#34;ghcr.io/foundation-model-stack/base:ray2.1.0-py38-gpu-pytorch1.12.0cu116-20221213-193103&#34;
+    image_pull_secrets: list = field(default_factory=list)</code></pre>
 </details>
 <h3>Class variables</h3>
 <dl>
@@ -142,6 +145,10 @@ <h3>Class variables</h3>
 <dd>
 <div class="desc"></div>
 </dd>
+<dt id="codeflare_sdk.cluster.config.ClusterConfiguration.image_pull_secrets"><code class="name">var <span class="ident">image_pull_secrets</span> : list</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
 <dt id="codeflare_sdk.cluster.config.ClusterConfiguration.instascale"><code class="name">var <span class="ident">instascale</span> : bool</code></dt>
 <dd>
 <div class="desc"></div>
@@ -211,6 +218,7 @@ <h4><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration" href="#co
 <li><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration.gpu" href="#codeflare_sdk.cluster.config.ClusterConfiguration.gpu">gpu</a></code></li>
 <li><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration.head_info" href="#codeflare_sdk.cluster.config.ClusterConfiguration.head_info">head_info</a></code></li>
 <li><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration.image" href="#codeflare_sdk.cluster.config.ClusterConfiguration.image">image</a></code></li>
+<li><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration.image_pull_secrets" href="#codeflare_sdk.cluster.config.ClusterConfiguration.image_pull_secrets">image_pull_secrets</a></code></li>
 <li><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration.instascale" href="#codeflare_sdk.cluster.config.ClusterConfiguration.instascale">instascale</a></code></li>
 <li><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration.machine_types" href="#codeflare_sdk.cluster.config.ClusterConfiguration.machine_types">machine_types</a></code></li>
 <li><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration.max_cpus" href="#codeflare_sdk.cluster.config.ClusterConfiguration.max_cpus">max_cpus</a></code></li>

docs/cluster/model.html

@@ -141,7 +141,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 <summary>
 <span>Expand source code</span>
 </summary>
-<pre><code class="python">class AppWrapper:
+<pre><code class="python">@dataclass
+class AppWrapper:
     &#34;&#34;&#34;
     For storing information about an AppWrapper.
     &#34;&#34;&#34;
@@ -284,7 +285,8 @@ <h3>Class variables</h3>
 <summary>
 <span>Expand source code</span>
 </summary>
-<pre><code class="python">class RayCluster:
+<pre><code class="python">@dataclass
+class RayCluster:
     &#34;&#34;&#34;
     For storing information about a Ray cluster.
     &#34;&#34;&#34;

docs/job/jobs.html

@@ -305,7 +305,7 @@ <h3>Methods</h3>
 </dd>
 <dt id="codeflare_sdk.job.jobs.DDPJobDefinition"><code class="flex name class">
 <span>class <span class="ident">DDPJobDefinition</span></span>
-<span>(</span><span>script: Optional[str] = None, m: Optional[str] = None, script_args: Optional[List[str]] = None, name: Optional[str] = None, cpu: Optional[int] = None, gpu: Optional[int] = None, memMB: Optional[int] = None, h: Optional[str] = None, j: Optional[str] = None, env: Optional[Dict[str, str]] = None, max_retries: int = 0, mounts: Optional[List[str]] = None, rdzv_port: int = 29500, rdzv_backend: str = None, scheduler_args: Optional[Dict[str, str]] = None, image: Optional[str] = None, workspace: Optional[str] = 'file:///home/meyceoz/Documents/codeflare-sdk')</span>
+<span>(</span><span>script: Optional[str] = None, m: Optional[str] = None, script_args: Optional[List[str]] = None, name: Optional[str] = None, cpu: Optional[int] = None, gpu: Optional[int] = None, memMB: Optional[int] = None, h: Optional[str] = None, j: Optional[str] = None, env: Optional[Dict[str, str]] = None, max_retries: int = 0, mounts: Optional[List[str]] = None, rdzv_port: int = 29500, rdzv_backend: str = None, scheduler_args: Optional[Dict[str, str]] = None, image: Optional[str] = None, workspace: Optional[str] = 'file:///home/eoingallinagh/Documents/RedHat/codeflare-sdk')</span>
 </code></dt>
 <dd>
 <div class="desc"></div>

docs/utils/generate_yaml.html

@@ -161,6 +161,14 @@ <h1 class="title">Module <code>codeflare_sdk.utils.generate_yaml</code></h1>
         container[&#34;image&#34;] = image
 
 
+def update_image_pull_secrets(spec, image_pull_secrets):
+    if image_pull_secrets:
+        if &#34;imagePullSecrets&#34; not in spec:
+            spec[&#34;imagePullSecrets&#34;] = []
+        for image_pull_secret in image_pull_secrets:
+            spec[&#34;imagePullSecrets&#34;].append({&#34;name&#34;: image_pull_secret})
+
+
 def update_env(spec, env):
     containers = spec.get(&#34;containers&#34;)
     for container in containers:
@@ -198,6 +206,7 @@ <h1 class="title">Module <code>codeflare_sdk.utils.generate_yaml</code></h1>
     image,
     instascale,
     env,
+    image_pull_secrets,
 ):
     if &#34;generictemplate&#34; in item.keys():
         head = item.get(&#34;generictemplate&#34;).get(&#34;spec&#34;).get(&#34;headGroupSpec&#34;)
@@ -213,6 +222,7 @@ <h1 class="title">Module <code>codeflare_sdk.utils.generate_yaml</code></h1>
         for comp in [head, worker]:
             spec = comp.get(&#34;template&#34;).get(&#34;spec&#34;)
             update_affinity(spec, appwrapper_name, instascale)
+            update_image_pull_secrets(spec, image_pull_secrets)
             update_image(spec, image)
             update_env(spec, env)
             if comp == head:
@@ -242,6 +252,7 @@ <h1 class="title">Module <code>codeflare_sdk.utils.generate_yaml</code></h1>
     instascale: bool,
     instance_types: list,
     env,
+    image_pull_secrets: list,
 ):
     user_yaml = read_template(template)
     appwrapper_name, cluster_name = gen_names(name)
@@ -265,6 +276,7 @@ <h1 class="title">Module <code>codeflare_sdk.utils.generate_yaml</code></h1>
         image,
         instascale,
         env,
+        image_pull_secrets,
     )
     update_dashboard_route(route_item, cluster_name, namespace)
     outfile = appwrapper_name + &#34;.yaml&#34;
@@ -346,6 +358,12 @@ <h1 class="title">Module <code>codeflare_sdk.utils.generate_yaml</code></h1>
         default=&#34;default&#34;,
         help=&#34;Set the kubernetes namespace you want to deploy your cluster to. Default. If left blank, uses the &#39;default&#39; namespace&#34;,
     )
+    parser.add_argument(
+        &#34;--image-pull-secrets&#34;,
+        required=False,
+        default=[],
+        help=&#34;Set image pull secrets for private registries&#34;,
+    )
 
     args = parser.parse_args()
     name = args.name
@@ -361,6 +379,7 @@ <h1 class="title">Module <code>codeflare_sdk.utils.generate_yaml</code></h1>
     instance_types = args.instance_types
     namespace = args.namespace
     env = {}
+    image_pull_secrets = args.image_pull_secrets
 
     outfile = generate_appwrapper(
         name,
@@ -376,6 +395,7 @@ <h1 class="title">Module <code>codeflare_sdk.utils.generate_yaml</code></h1>
         instascale,
         instance_types,
         env,
+        image_pull_secrets,
     )
     return outfile
 
@@ -411,7 +431,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
 </details>
 </dd>
 <dt id="codeflare_sdk.utils.generate_yaml.generate_appwrapper"><code class="name flex">
-<span>def <span class="ident">generate_appwrapper</span></span>(<span>name: str, namespace: str, min_cpu: int, max_cpu: int, min_memory: int, max_memory: int, gpu: int, workers: int, template: str, image: str, instascale: bool, instance_types: list, env)</span>
+<span>def <span class="ident">generate_appwrapper</span></span>(<span>name: str, namespace: str, min_cpu: int, max_cpu: int, min_memory: int, max_memory: int, gpu: int, workers: int, template: str, image: str, instascale: bool, instance_types: list, env, image_pull_secrets: list)</span>
 </code></dt>
 <dd>
 <div class="desc"></div>
@@ -433,6 +453,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
     instascale: bool,
     instance_types: list,
     env,
+    image_pull_secrets: list,
 ):
     user_yaml = read_template(template)
     appwrapper_name, cluster_name = gen_names(name)
@@ -456,6 +477,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
         image,
         instascale,
         env,
+        image_pull_secrets,
     )
     update_dashboard_route(route_item, cluster_name, namespace)
     outfile = appwrapper_name + &#34;.yaml&#34;
@@ -546,6 +568,12 @@ <h2 class="section-title" id="header-functions">Functions</h2>
         default=&#34;default&#34;,
         help=&#34;Set the kubernetes namespace you want to deploy your cluster to. Default. If left blank, uses the &#39;default&#39; namespace&#34;,
     )
+    parser.add_argument(
+        &#34;--image-pull-secrets&#34;,
+        required=False,
+        default=[],
+        help=&#34;Set image pull secrets for private registries&#34;,
+    )
 
     args = parser.parse_args()
     name = args.name
@@ -561,6 +589,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
     instance_types = args.instance_types
     namespace = args.namespace
     env = {}
+    image_pull_secrets = args.image_pull_secrets
 
     outfile = generate_appwrapper(
         name,
@@ -576,6 +605,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
         instascale,
         instance_types,
         env,
+        image_pull_secrets,
     )
     return outfile</code></pre>
 </details>
@@ -715,6 +745,23 @@ <h2 class="section-title" id="header-functions">Functions</h2>
         container[&#34;image&#34;] = image</code></pre>
 </details>
 </dd>
+<dt id="codeflare_sdk.utils.generate_yaml.update_image_pull_secrets"><code class="name flex">
+<span>def <span class="ident">update_image_pull_secrets</span></span>(<span>spec, image_pull_secrets)</span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">def update_image_pull_secrets(spec, image_pull_secrets):
+    if image_pull_secrets:
+        if &#34;imagePullSecrets&#34; not in spec:
+            spec[&#34;imagePullSecrets&#34;] = []
+        for image_pull_secret in image_pull_secrets:
+            spec[&#34;imagePullSecrets&#34;].append({&#34;name&#34;: image_pull_secret})</code></pre>
+</details>
+</dd>
 <dt id="codeflare_sdk.utils.generate_yaml.update_labels"><code class="name flex">
 <span>def <span class="ident">update_labels</span></span>(<span>yaml, instascale, instance_types)</span>
 </code></dt>
@@ -760,7 +807,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
 </details>
 </dd>
 <dt id="codeflare_sdk.utils.generate_yaml.update_nodes"><code class="name flex">
-<span>def <span class="ident">update_nodes</span></span>(<span>item, appwrapper_name, min_cpu, max_cpu, min_memory, max_memory, gpu, workers, image, instascale, env)</span>
+<span>def <span class="ident">update_nodes</span></span>(<span>item, appwrapper_name, min_cpu, max_cpu, min_memory, max_memory, gpu, workers, image, instascale, env, image_pull_secrets)</span>
 </code></dt>
 <dd>
 <div class="desc"></div>
@@ -780,6 +827,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
     image,
     instascale,
     env,
+    image_pull_secrets,
 ):
     if &#34;generictemplate&#34; in item.keys():
         head = item.get(&#34;generictemplate&#34;).get(&#34;spec&#34;).get(&#34;headGroupSpec&#34;)
@@ -795,6 +843,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
         for comp in [head, worker]:
             spec = comp.get(&#34;template&#34;).get(&#34;spec&#34;)
             update_affinity(spec, appwrapper_name, instascale)
+            update_image_pull_secrets(spec, image_pull_secrets)
             update_image(spec, image)
             update_env(spec, env)
             if comp == head:
@@ -870,6 +919,7 @@ <h1>Index</h1>
 <li><code><a title="codeflare_sdk.utils.generate_yaml.update_dashboard_route" href="#codeflare_sdk.utils.generate_yaml.update_dashboard_route">update_dashboard_route</a></code></li>
 <li><code><a title="codeflare_sdk.utils.generate_yaml.update_env" href="#codeflare_sdk.utils.generate_yaml.update_env">update_env</a></code></li>
 <li><code><a title="codeflare_sdk.utils.generate_yaml.update_image" href="#codeflare_sdk.utils.generate_yaml.update_image">update_image</a></code></li>
+<li><code><a title="codeflare_sdk.utils.generate_yaml.update_image_pull_secrets" href="#codeflare_sdk.utils.generate_yaml.update_image_pull_secrets">update_image_pull_secrets</a></code></li>
 <li><code><a title="codeflare_sdk.utils.generate_yaml.update_labels" href="#codeflare_sdk.utils.generate_yaml.update_labels">update_labels</a></code></li>
 <li><code><a title="codeflare_sdk.utils.generate_yaml.update_names" href="#codeflare_sdk.utils.generate_yaml.update_names">update_names</a></code></li>
 <li><code><a title="codeflare_sdk.utils.generate_yaml.update_nodes" href="#codeflare_sdk.utils.generate_yaml.update_nodes">update_nodes</a></code></li>