Skip to content

Changes in docs for release: v0.20.2 #660

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 6, 2024
Merged

Changes in docs for release: v0.20.2 #660

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 57 additions & 2 deletions docs/detailed-documentation/utils/generate_cert.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ <h1 class="title">Module <code>codeflare_sdk.utils.generate_cert</code></h1>
import datetime
from ..cluster.auth import config_check, api_config_handler
from kubernetes import client, config
from .kube_api_helpers import _kube_api_error_handling


def generate_ca_cert(days: int = 30):
Expand Down Expand Up @@ -102,6 +103,24 @@ <h1 class="title">Module <code>codeflare_sdk.utils.generate_cert</code></h1>
return key, certificate


def get_secret_name(cluster_name, namespace, api_instance):
label_selector = f&#34;ray.openshift.ai/cluster-name={cluster_name}&#34;
try:
secrets = api_instance.list_namespaced_secret(
namespace, label_selector=label_selector
)
for secret in secrets.items:
if (
f&#34;{cluster_name}-ca-secret-&#34; in secret.metadata.name
): # Oauth secret share the same label this conditional is to make things more specific
return secret.metadata.name
else:
continue
raise KeyError(f&#34;Unable to gather secret name for {cluster_name}&#34;)
except Exception as e: # pragma: no cover
return _kube_api_error_handling(e)


def generate_tls_cert(cluster_name, namespace, days=30):
# Create a folder tls-&lt;cluster&gt;-&lt;namespace&gt; and store three files: ca.crt, tls.crt, and tls.key
tls_dir = os.path.join(os.getcwd(), f&#34;tls-{cluster_name}-{namespace}&#34;)
Expand All @@ -113,7 +132,11 @@ <h1 class="title">Module <code>codeflare_sdk.utils.generate_cert</code></h1>
# oc get secret ca-secret-&lt;cluster-name&gt; -o template=&#39;{{index .data &#34;ca.crt&#34;}}&#39;|base64 -d &gt; ${TLSDIR}/ca.crt
config_check()
v1 = client.CoreV1Api(api_config_handler())
secret = v1.read_namespaced_secret(f&#34;ca-secret-{cluster_name}&#34;, namespace).data

# Secrets have a suffix appended to the end so we must list them and gather the secret that includes cluster_name-ca-secret-
secret_name = get_secret_name(cluster_name, namespace, v1)
secret = v1.read_namespaced_secret(secret_name, namespace).data

ca_cert = secret.get(&#34;ca.crt&#34;)
ca_key = secret.get(&#34;ca.key&#34;)

Expand Down Expand Up @@ -294,7 +317,11 @@ <h2 class="section-title" id="header-functions">Functions</h2>
# oc get secret ca-secret-&lt;cluster-name&gt; -o template=&#39;{{index .data &#34;ca.crt&#34;}}&#39;|base64 -d &gt; ${TLSDIR}/ca.crt
config_check()
v1 = client.CoreV1Api(api_config_handler())
secret = v1.read_namespaced_secret(f&#34;ca-secret-{cluster_name}&#34;, namespace).data

# Secrets have a suffix appended to the end so we must list them and gather the secret that includes cluster_name-ca-secret-
secret_name = get_secret_name(cluster_name, namespace, v1)
secret = v1.read_namespaced_secret(secret_name, namespace).data

ca_cert = secret.get(&#34;ca.crt&#34;)
ca_key = secret.get(&#34;ca.key&#34;)

Expand Down Expand Up @@ -363,6 +390,33 @@ <h2 class="section-title" id="header-functions">Functions</h2>
f.write(tls_cert.public_bytes(serialization.Encoding.PEM).decode(&#34;utf-8&#34;))</code></pre>
</details>
</dd>
<dt id="codeflare_sdk.utils.generate_cert.get_secret_name"><code class="name flex">
<span>def <span class="ident">get_secret_name</span></span>(<span>cluster_name, namespace, api_instance)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def get_secret_name(cluster_name, namespace, api_instance):
label_selector = f&#34;ray.openshift.ai/cluster-name={cluster_name}&#34;
try:
secrets = api_instance.list_namespaced_secret(
namespace, label_selector=label_selector
)
for secret in secrets.items:
if (
f&#34;{cluster_name}-ca-secret-&#34; in secret.metadata.name
): # Oauth secret share the same label this conditional is to make things more specific
return secret.metadata.name
else:
continue
raise KeyError(f&#34;Unable to gather secret name for {cluster_name}&#34;)
except Exception as e: # pragma: no cover
return _kube_api_error_handling(e)</code></pre>
</details>
</dd>
</dl>
</section>
<section>
Expand All @@ -384,6 +438,7 @@ <h1>Index</h1>
<li><code><a title="codeflare_sdk.utils.generate_cert.export_env" href="#codeflare_sdk.utils.generate_cert.export_env">export_env</a></code></li>
<li><code><a title="codeflare_sdk.utils.generate_cert.generate_ca_cert" href="#codeflare_sdk.utils.generate_cert.generate_ca_cert">generate_ca_cert</a></code></li>
<li><code><a title="codeflare_sdk.utils.generate_cert.generate_tls_cert" href="#codeflare_sdk.utils.generate_cert.generate_tls_cert">generate_tls_cert</a></code></li>
<li><code><a title="codeflare_sdk.utils.generate_cert.get_secret_name" href="#codeflare_sdk.utils.generate_cert.get_secret_name">get_secret_name</a></code></li>
</ul>
</li>
</ul>
Expand Down