Skip to content

Commit

Permalink
deploy: 0a7fd6f
Browse files Browse the repository at this point in the history
  • Loading branch information
tobias-urdin committed Apr 26, 2024
1 parent 4537f8e commit f1f691d
Show file tree
Hide file tree
Showing 3 changed files with 97 additions and 41 deletions.
59 changes: 41 additions & 18 deletions _sources/compute/shelving-an-instance.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,32 +2,55 @@
Shelving an instance
====================

Shelving an instance is a way to leave an instance permanently shut down for a period of time, either because its temporarily not needed or because as part of an decommissioning process, its to be saved in an offline state for some time.
Shelving an instance allows you to save the data for your instance but release
the allocated resources required to run the instance and decrease the price you
pay for resource you're don't currently need.

.. note:: In Binero cloud, instances that are not running are only billed at a 20% rate. This is due to the resource allocation that is still happening in the background. It makes no difference if an instance is shelved or just turned off from a billing perspective, however shelving an instance does make it clear that the instance is not just switched off in error as well as prevents it from being booted by accident.
Shelving an instance saves your data by uploading it to the image service and
storage such as volumes are not touched. The metadata about your instance is
saved and any compute allocations is released.

Currently, shelving is only possible via :doc:`/getting-started/managing-your-cloud/openstack-horizon` or :doc:`/getting-started/managing-your-cloud/openstack-terminal-client`.
You can at any time unshelve the instance and start it again.

OpenStack Horizon
-----------------
.. tip:: Shelving also works for our GPU and NVME based flavors.

To shelve an `instance <index>`_ using the Horizon portal follow these steps:
.. note:: Shelved instances reduces your cost for allocated resources for the
instance but you still pay for the used storage, such as root disk
and volumes.

- Under "project", click "compute" and then "instances" in the sidebar menu.
- In the drop-down menu to the far right of the line corresponding to the instance you want to resize, press "Shelve instance".
Shelve an instance using Cloud portal
-------------------------------------

The instance will be shutdown (if its running) and the shelving process will run. To un-shelve repeat the process but instead choose "Un shelve instance".
To shelve an `instance <index>`_ from the :doc:`/getting-started/managing-your-cloud/cloud-management-portal`

OpenStack terminal client
-------------------------
- Click **Compute** -> **Instances** in the sidebar menu.

To shelve an `instance <index>`_ using the OpenStack terminal client, follow these steps:
- On the card for the instance click the dropdown menu and click the **Shelve** action

- Identify the instance you want to shelve. This can be done by running the following command: ``openstack server list``.
- To shelve the instance ``openstack server shelve [NAME]``. Replace the values within brackets with the name of the instance from the previous step.
Shelve an instance using OpenStack Horizon
------------------------------------------

The instance will be shutdown (if its running) and the shelving process will run. To un-shelve repeat the process but instead run the following command: ``openstack server unshelve [NAME]``.
- Click **Project** -> **Compute** -> **Instances** in the sidebar menu.

.. seealso::
- :doc:`/getting-started/managing-your-cloud/cloud-management-portal`
- :doc:`/getting-started/managing-your-cloud/openstack-terminal-client`
- In the dropdown menu to the right for hte instance, click **Shelve instance**.

The instance will be powered off (if its in a running state) and then the shelving process will start. To unshelve the instance
repeat the same process but click **Unshelve instance** in the dropdown menu.

Shelve an instance using OpenStack Terminal client
--------------------------------------------------

To shelve an `instance <index>`_ using the OpenStack terminal client.

- Identify the instance you want to shelve. This can be done by listing existing instance with ``openstack server list``

- To shelve the instance run ``openstack server shelve [NAME]``. Replace the values within brackets with the name of the
instance from the previous step.

The instance will be powered off (if its in a running state) and then the shelving process will start. To unshelve the instance
repeat the same process but instead run ``openstack server unshelve [NAME]``

.. seealso::

- :doc:`/getting-started/managing-your-cloud/cloud-management-portal`
- :doc:`/getting-started/managing-your-cloud/openstack-terminal-client`
77 changes: 55 additions & 22 deletions compute/shelving-an-instance.html
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@
<div data-md-component="skip">


<a href="#openstack-horizon" class="md-skip">
<a href="#shelve-an-instance-using-cloud-portal" class="md-skip">
Skip to content
</a>

Expand Down Expand Up @@ -688,15 +688,22 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#openstack-horizon" class="md-nav__link">
<span class="md-ellipsis">Open<wbr>Stack Horizon</span>
<a href="#shelve-an-instance-using-cloud-portal" class="md-nav__link">
<span class="md-ellipsis">Shelve an instance using Cloud portal</span>
</a>

</li>

<li class="md-nav__item">
<a href="#openstack-terminal-client" class="md-nav__link">
<span class="md-ellipsis">Open<wbr>Stack terminal client</span>
<a href="#shelve-an-instance-using-openstack-horizon" class="md-nav__link">
<span class="md-ellipsis">Shelve an instance using Open<wbr>Stack Horizon</span>
</a>

</li>

<li class="md-nav__item">
<a href="#shelve-an-instance-using-openstack-terminal-client" class="md-nav__link">
<span class="md-ellipsis">Shelve an instance using Open<wbr>Stack Terminal client</span>
</a>

</li>
Expand Down Expand Up @@ -1038,15 +1045,22 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#openstack-horizon" class="md-nav__link">
<span class="md-ellipsis">Open<wbr>Stack Horizon</span>
<a href="#shelve-an-instance-using-cloud-portal" class="md-nav__link">
<span class="md-ellipsis">Shelve an instance using Cloud portal</span>
</a>

</li>

<li class="md-nav__item">
<a href="#openstack-terminal-client" class="md-nav__link">
<span class="md-ellipsis">Open<wbr>Stack terminal client</span>
<a href="#shelve-an-instance-using-openstack-horizon" class="md-nav__link">
<span class="md-ellipsis">Shelve an instance using Open<wbr>Stack Horizon</span>
</a>

</li>

<li class="md-nav__item">
<a href="#shelve-an-instance-using-openstack-terminal-client" class="md-nav__link">
<span class="md-ellipsis">Shelve an instance using Open<wbr>Stack Terminal client</span>
</a>

</li>
Expand All @@ -1071,26 +1085,45 @@
</a>

<h1 id="shelving-an-instance">Shelving an instance<a class="headerlink" href="#shelving-an-instance" title="Link to this heading"></a></h1>
<p>Shelving an instance is a way to leave an instance permanently shut down for a period of time, either because its temporarily not needed or because as part of an decommissioning process, its to be saved in an offline state for some time.</p>
<p>Shelving an instance allows you to save the data for your instance but release
the allocated resources required to run the instance and decrease the price you
pay for resource you’re don’t currently need.</p>
<p>Shelving an instance saves your data by uploading it to the image service and
storage such as volumes are not touched. The metadata about your instance is
saved and any compute allocations is released.</p>
<p>You can at any time unshelve the instance and start it again.</p>
<div class="tip admonition">
<p class="admonition-title">Tip</p>
<p>Shelving also works for our GPU and NVME based flavors.</p>
</div>
<div class="note admonition">
<p class="admonition-title">Note</p>
<p>In Binero cloud, instances that are not running are only billed at a 20% rate. This is due to the resource allocation that is still happening in the background. It makes no difference if an instance is shelved or just turned off from a billing perspective, however shelving an instance does make it clear that the instance is not just switched off in error as well as prevents it from being booted by accident.</p>
<p>Shelved instances reduces your cost for allocated resources for the
instance but you still pay for the used storage, such as root disk
and volumes.</p>
</div>
<p>Currently, shelving is only possible via <a class="reference internal" href="../getting-started/managing-your-cloud/openstack-horizon.html"><span class="doc">OpenStack Horizon</span></a> or <a class="reference internal" href="../getting-started/managing-your-cloud/openstack-terminal-client.html"><span class="doc">OpenStack terminal client</span></a>.</p>
<h2 id="openstack-horizon">OpenStack Horizon<a class="headerlink" href="#openstack-horizon" title="Link to this heading"></a></h2>
<p>To shelve an <a class="reference external" href="index">instance</a> using the Horizon portal follow these steps:</p>
<h2 id="shelve-an-instance-using-cloud-portal">Shelve an instance using Cloud portal<a class="headerlink" href="#shelve-an-instance-using-cloud-portal" title="Link to this heading"></a></h2>
<p>To shelve an <a class="reference external" href="index">instance</a> from the <a class="reference internal" href="../getting-started/managing-your-cloud/cloud-management-portal.html"><span class="doc">Cloud management portal</span></a></p>
<ul class="simple">
<li><p>Click <strong>Compute</strong> -&gt; <strong>Instances</strong> in the sidebar menu.</p></li>
<li><p>On the card for the instance click the dropdown menu and click the <strong>Shelve</strong> action</p></li>
</ul>
<h2 id="shelve-an-instance-using-openstack-horizon">Shelve an instance using OpenStack Horizon<a class="headerlink" href="#shelve-an-instance-using-openstack-horizon" title="Link to this heading"></a></h2>
<ul class="simple">
<li><p>Under “project”, click “compute” and then “instances” in the sidebar menu.</p></li>
<li><p>In the drop-down menu to the far right of the line corresponding to the instance you want to resize, press “Shelve instance.</p></li>
<li><p>Click <strong>Project</strong> -&gt; <strong>Compute</strong> -&gt; <strong>Instances</strong> in the sidebar menu.</p></li>
<li><p>In the dropdown menu to the right for hte instance, click <strong>Shelve instance</strong>.</p></li>
</ul>
<p>The instance will be shutdown (if its running) and the shelving process will run. To un-shelve repeat the process but instead choose “Un shelve instance”.</p>
<h2 id="openstack-terminal-client">OpenStack terminal client<a class="headerlink" href="#openstack-terminal-client" title="Link to this heading"></a></h2>
<p>To shelve an <a class="reference external" href="index">instance</a> using the OpenStack terminal client, follow these steps:</p>
<p>The instance will be powered off (if its in a running state) and then the shelving process will start. To unshelve the instance
repeat the same process but click <strong>Unshelve instance</strong> in the dropdown menu.</p>
<h2 id="shelve-an-instance-using-openstack-terminal-client">Shelve an instance using OpenStack Terminal client<a class="headerlink" href="#shelve-an-instance-using-openstack-terminal-client" title="Link to this heading"></a></h2>
<p>To shelve an <a class="reference external" href="index">instance</a> using the OpenStack terminal client.</p>
<ul class="simple">
<li><p>Identify the instance you want to shelve. This can be done by running the following command: <code class="docutils literal notranslate"><span class="pre">openstack</span> <span class="pre">server</span> <span class="pre">list</span></code>.</p></li>
<li><p>To shelve the instance <code class="docutils literal notranslate"><span class="pre">openstack</span> <span class="pre">server</span> <span class="pre">shelve</span> <span class="pre">[NAME]</span></code>. Replace the values within brackets with the name of the instance from the previous step.</p></li>
<li><p>Identify the instance you want to shelve. This can be done by listing existing instance with <code class="docutils literal notranslate"><span class="pre">openstack</span> <span class="pre">server</span> <span class="pre">list</span></code></p></li>
<li><p>To shelve the instance run <code class="docutils literal notranslate"><span class="pre">openstack</span> <span class="pre">server</span> <span class="pre">shelve</span> <span class="pre">[NAME]</span></code>. Replace the values within brackets with the name of the
instance from the previous step.</p></li>
</ul>
<p>The instance will be shutdown (if its running) and the shelving process will run. To un-shelve repeat the process but instead run the following command: <code class="docutils literal notranslate"><span class="pre">openstack</span> <span class="pre">server</span> <span class="pre">unshelve</span> <span class="pre">[NAME]</span></code>.</p>
<p>The instance will be powered off (if its in a running state) and then the shelving process will start. To unshelve the instance
repeat the same process but instead run <code class="docutils literal notranslate"><span class="pre">openstack</span> <span class="pre">server</span> <span class="pre">unshelve</span> <span class="pre">[NAME]</span></code></p>
<div class="seealso admonition">
<p class="admonition-title">See also</p>
<ul class="simple">
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

0 comments on commit f1f691d

Please sign in to comment.