Skip to content

Commit

Permalink
Deployed 7692cae35 to latest in docs/rook with MkDocs 1.6.1 and mike …
Browse files Browse the repository at this point in the history
…2.1.3
  • Loading branch information
Rook committed Nov 5, 2024
1 parent 19cfa55 commit a6090b3
Show file tree
Hide file tree
Showing 5 changed files with 86 additions and 86 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<a id=__codelineno-0-6 name=__codelineno-0-6></a><span class=nt>spec</span><span class=p>:</span>
<a id=__codelineno-0-7 name=__codelineno-0-7></a><span class=w> </span><span class=c1># The name of the CephBlockPool CR where the namespace is created.</span>
<a id=__codelineno-0-8 name=__codelineno-0-8></a><span class=w> </span><span class=nt>blockPoolName</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">replicapool</span>
</code></pre></div></td></tr></table></div> <h2 id=settings>Settings<a class=headerlink href=#settings title="Permanent link">&para;</a></h2> <p>If any setting is unspecified, a suitable default will be used automatically.</p> <h3 id=metadata>Metadata<a class=headerlink href=#metadata title="Permanent link">&para;</a></h3> <ul> <li><code>name</code>: The name that will be used for the Ceph BlockPool rados namespace.</li> </ul> <h3 id=spec>Spec<a class=headerlink href=#spec title="Permanent link">&para;</a></h3> <ul> <li> <p><code>blockPoolName</code>: The metadata name of the CephBlockPool CR where the rados namespace will be created.</p> </li> <li> <p><code>mirroring</code>: Sets up mirroring of the rados namespace (requires Ceph v20 or newer)</p> <ul> <li><code>mode</code>: mirroring mode to run, possible values are "pool" or "image" (required). Refer to the <a href=https://docs.ceph.com/docs/master/rbd/rbd-mirroring/#enable-mirroring>mirroring modes Ceph documentation</a> for more details</li> <li><code>remoteNamespace</code>: Name of the rados namespace on the peer cluster where the namespace should get mirrored. The default is the same rados namespace.</li> <li><code>snapshotSchedules</code>: schedule(s) snapshot at the <strong>rados namespace</strong> level. It is an array and one or more schedules are supported.<ul> <li><code>interval</code>: frequency of the snapshots. The interval can be specified in days, hours, or minutes using d, h, m suffix respectively.</li> <li><code>startTime</code>: optional, determines at what time the snapshot process starts, specified using the ISO 8601 time format.</li> </ul> </li> </ul> </li> </ul> <h2 id=creating-a-storage-class>Creating a Storage Class<a class=headerlink href=#creating-a-storage-class title="Permanent link">&para;</a></h2> <p>Once the RADOS namespace is created, an RBD-based StorageClass can be created to create PVs in this RADOS namespace. For this purpose, the <code>clusterID</code> value from the CephBlockPoolRadosNamespace status needs to be put into the <code>clusterID</code> field of the StorageClass spec.</p> <p>Extract the clusterID from the CephBlockPoolRadosNamespace CR:</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>
</code></pre></div></td></tr></table></div> <h2 id=settings>Settings<a class=headerlink href=#settings title="Permanent link">&para;</a></h2> <p>If any setting is unspecified, a suitable default will be used automatically.</p> <h3 id=metadata>Metadata<a class=headerlink href=#metadata title="Permanent link">&para;</a></h3> <ul> <li><code>name</code>: The name that will be used for the Ceph BlockPool rados namespace.</li> </ul> <h3 id=spec>Spec<a class=headerlink href=#spec title="Permanent link">&para;</a></h3> <ul> <li> <p><code>blockPoolName</code>: The metadata name of the CephBlockPool CR where the rados namespace will be created.</p> </li> <li> <p><code>mirroring</code>: Sets up mirroring of the rados namespace (requires Ceph v20 or newer)</p> <ul> <li><code>mode</code>: mirroring mode to run, possible values are "pool" or "image" (required). Refer to the <a href=https://docs.ceph.com/docs/master/rbd/rbd-mirroring/#enable-mirroring>mirroring modes Ceph documentation</a> for more details</li> <li><code>remoteNamespace</code>: Name of the rados namespace on the peer cluster where the namespace should get mirrored. The default is the same rados namespace.</li> <li><code>snapshotSchedules</code>: schedule(s) snapshot at the <strong>rados namespace</strong> level. It is an array and one or more schedules are supported.<ul> <li><code>interval</code>: frequency of the snapshots. The interval can be specified in days, hours, or minutes using d, h, m suffix respectively.</li> <li><code>startTime</code>: optional, determines at what time the snapshot process starts, specified using the ISO 8601 time format.</li> </ul> </li> </ul> </li> </ul> <div class="admonition note"> <p class=admonition-title>Note</p> <p>If mirroring is enabled, whether to monitor the status and the interval of status updates is based on the <code>statusCheck</code> spec values of the parent CephBlockPool CR.</p> </div> <h2 id=creating-a-storage-class>Creating a Storage Class<a class=headerlink href=#creating-a-storage-class title="Permanent link">&para;</a></h2> <p>Once the RADOS namespace is created, an RBD-based StorageClass can be created to create PVs in this RADOS namespace. For this purpose, the <code>clusterID</code> value from the CephBlockPoolRadosNamespace status needs to be put into the <code>clusterID</code> field of the StorageClass spec.</p> <p>Extract the clusterID from the CephBlockPoolRadosNamespace CR:</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>
<span class=normal><a href=#__codelineno-1-2>2</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=gp>$ </span>kubectl<span class=w> </span>-n<span class=w> </span>rook-ceph<span class=w> </span>get<span class=w> </span>cephblockpoolradosnamespace/namespace-a<span class=w> </span>-o<span class=w> </span><span class=nv>jsonpath</span><span class=o>=</span><span class=s1>&#39;{.status.info.clusterID}&#39;</span>
<a id=__codelineno-1-2 name=__codelineno-1-2></a><span class=go>80fc4f4bacc064be641633e6ed25ba7e</span>
</code></pre></div></td></tr></table></div> <p>In this example, replace <code>namespace-a</code> by the actual name of the radosnamespace created before. Now set the <code>clusterID</code> retrieved from the previous step into the <code>clusterID</code> of the storage class.</p> <p>Example:</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>
Expand Down
2 changes: 1 addition & 1 deletion docs/rook/latest/CRDs/specification/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/rook/latest/search/search_index.json

Large diffs are not rendered by default.

Loading

0 comments on commit a6090b3

Please sign in to comment.