Skip to content

Commit

Permalink
Deployed 01d8e5ea3 to v1.15 in docs/rook with MkDocs 1.6.1 and mike 2…
Browse files Browse the repository at this point in the history
….1.3
  • Loading branch information
Rook committed Nov 8, 2024
1 parent a4146b8 commit c9ab427
Show file tree
Hide file tree
Showing 41 changed files with 147 additions and 148 deletions.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/rook/v1.15/CRDs/Cluster/ceph-cluster-crd/index.html

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@
<span class=normal><a href=#__codelineno-0-2>2</a></span></pre></div></td><td class=code><div><pre><span></span><code><a id=__codelineno-0-1 name=__codelineno-0-1></a><span class=go>toolbox=$(kubectl get pod -l app=rook-ceph-tools -n rook-ceph -o jsonpath=&#39;{.items[*].metadata.name}&#39;)</span>
<a id=__codelineno-0-2 name=__codelineno-0-2></a><span class=go>kubectl -n rook-ceph cp deploy/examples/external/create-external-cluster-resources.py $toolbox:/etc/ceph</span>
</code></pre></div></td></tr></table></div> </li> <li> <p>Exec to the toolbox pod and execute create-external-cluster-resources.py with needed options to create required <a href=../provider-export/#1-create-all-users-and-keys>users and keys</a>.</p> </li> </ol> <div class="admonition important"> <p class=admonition-title>Important</p> <p>For other clusters to connect to storage in this cluster, Rook must be configured with a networking configuration that is accessible from other clusters. Most commonly this is done by enabling host networking in the CephCluster CR so the Ceph daemons will be addressable by their host IPs.</p> </div> <h2 id=admin-privileges>Admin privileges<a class=headerlink href=#admin-privileges title="Permanent link">&para;</a></h2> <p>If in case the cluster needs the admin keyring to configure, update the admin key <code>rook-ceph-mon</code> secret with client.admin keyring</p> <div class="admonition note"> <p class=admonition-title>Note</p> <p>Sharing the admin key with the external cluster is not generally recommended</p> </div> <ol> <li> <p>Get the <code>client.admin</code> keyring from the ceph cluster</p> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-1-1>1</a></span></pre></div></td><td class=code><div><pre><span></span><code><a id=__codelineno-1-1 name=__codelineno-1-1></a><span class=go>ceph auth get client.admin</span>
</code></pre></div></td></tr></table></div> </li> <li> <p>Update two values in the <code>rook-ceph-mon</code> secret:</p> <ul> <li><code>ceph-username</code>: Set to <code>client.admin</code></li> <li><code>ceph-secret</code>: Set the client.admin keyring</li> </ul> </li> </ol> <p>After restarting the rook operator (and the toolbox if in use), rook will configure ceph with admin privileges.</p> <h2 id=connect-to-an-external-object-store>Connect to an External Object Store<a class=headerlink href=#connect-to-an-external-object-store title="Permanent link">&para;</a></h2> <p>Create the <a href=https://github.com/rook/rook/blob/HEAD/deploy/examples/external/object-external.yaml>external object store CR</a> to configure connection to external gateways.</p> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-2-1>1</a></span>
</code></pre></div></td></tr></table></div> </li> <li> <p>Update two values in the <code>rook-ceph-mon</code> secret:</p> <ul> <li><code>ceph-username</code>: Set to <code>client.admin</code></li> <li><code>ceph-secret</code>: Set the client.admin keyring</li> </ul> </li> </ol> <p>After restarting the rook operator (and the toolbox if in use), rook will configure ceph with admin privileges.</p> <h2 id=connect-to-an-external-object-store>Connect to an External Object Store<a class=headerlink href=#connect-to-an-external-object-store title="Permanent link">&para;</a></h2> <p>Create the <a href=https://github.com/rook/rook/blob/release-1.15/deploy/examples/external/object-external.yaml>external object store CR</a> to configure connection to external gateways.</p> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-2-1>1</a></span>
<span class=normal><a href=#__codelineno-2-2>2</a></span></pre></div></td><td class=code><div><pre><span></span><code><a id=__codelineno-2-1 name=__codelineno-2-1></a><span class=go>cd deploy/examples/external</span>
<a id=__codelineno-2-2 name=__codelineno-2-2></a><span class=go>kubectl create -f object-external.yaml</span>
</code></pre></div></td></tr></table></div> <p>Consume the S3 Storage, in two different ways:</p> <ol> <li> <p>Create an <a href=https://github.com/rook/rook/blob/HEAD/deploy/examples/object-user.yaml>Object store user</a> for credentials to access the S3 endpoint.</p> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-3-1>1</a></span>
</code></pre></div></td></tr></table></div> <p>Consume the S3 Storage, in two different ways:</p> <ol> <li> <p>Create an <a href=https://github.com/rook/rook/blob/release-1.15/deploy/examples/object-user.yaml>Object store user</a> for credentials to access the S3 endpoint.</p> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-3-1>1</a></span>
<span class=normal><a href=#__codelineno-3-2>2</a></span></pre></div></td><td class=code><div><pre><span></span><code><a id=__codelineno-3-1 name=__codelineno-3-1></a><span class=go>cd deploy/examples</span>
<a id=__codelineno-3-2 name=__codelineno-3-2></a><span class=go>kubectl create -f object-user.yaml</span>
</code></pre></div></td></tr></table></div> </li> <li> <p>Create a <a href=https://github.com/rook/rook/blob/master/deploy/examples/external/storageclass-bucket-delete.yaml>bucket storage class</a> where a client can request creating buckets and then create the <a href=https://github.com/rook/rook/blob/HEAD/deploy/examples/external/object-bucket-claim-delete.yaml>Object Bucket Claim</a>, which will create an individual bucket for reading and writing objects.</p> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-4-1>1</a></span>
</code></pre></div></td></tr></table></div> </li> <li> <p>Create a <a href=https://github.com/rook/rook/blob/master/deploy/examples/external/storageclass-bucket-delete.yaml>bucket storage class</a> where a client can request creating buckets and then create the <a href=https://github.com/rook/rook/blob/release-1.15/deploy/examples/external/object-bucket-claim-delete.yaml>Object Bucket Claim</a>, which will create an individual bucket for reading and writing objects.</p> <div class=highlight><table class=highlighttable><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-4-1>1</a></span>
<span class=normal><a href=#__codelineno-4-2>2</a></span>
<span class=normal><a href=#__codelineno-4-3>3</a></span></pre></div></td><td class=code><div><pre><span></span><code><a id=__codelineno-4-1 name=__codelineno-4-1></a><span class=go>cd deploy/examples/external</span>
<a id=__codelineno-4-2 name=__codelineno-4-2></a><span class=go>kubectl create -f storageclass-bucket-delete.yaml</span>
Expand Down
Loading

0 comments on commit c9ab427

Please sign in to comment.