Skip to content

Commit e05b854

Browse files
vichanssonprisorue
authored and
rsmontero
committed
F OpenNebula/one#6373: Update docs (#318)
Signed-off-by: Victor Hansson <vhansson@opennebula.io> Co-authored-by: Priscill Orue <porue@opennebula.io> (cherry picked from commit 7843c7e)
1 parent e9731c6 commit e05b854

File tree

2 files changed

+26
-24
lines changed

2 files changed

+26
-24
lines changed

‎assets/images/sunstone_ds_cache_config.png‎

321 KB
Loading

‎content/product/cluster_configuration/storage_system/local_ds.md‎

Lines changed: 26 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ This storage configuration uses the local storage area of each Host to run VMs.
1919

2020
The Front-end needs to prepare the storage area for:
2121

22-
* **Image Datastores** to store the image repository.
23-
* **System Datastores** to hold temporary disks and files for VMs `stopped` and `undeployed`.
22+
- **Image Datastores** to store the image repository.
23+
- **System Datastores** to hold temporary disks and files for VMs `stopped` and `undeployed`.
2424

2525
Simply make sure that there is enough space under `/var/lib/one/datastores` to store images and the disks of the `stopped` and `undeployed` Virtual Machines. Note that `/var/lib/one/datastores` **can be mounted from any NAS/SAN server in your network**.
2626

@@ -29,7 +29,7 @@ Simply make sure that there is enough space under `/var/lib/one/datastores` to s
2929
Just make sure that there is enough space under `/var/lib/one/datastores` to store the disks of running VMs on that Host.
3030

3131
{{< alert title="Warning" color="warning" >}}
32-
Make sure all the Hosts, including the Front-end, can SSH to any other Host (including themselves), otherwise migrations will not work.{{< /alert >}}
32+
Ensure that all Hosts, including the Front-end, can remotely connect via SSH to any other Host (and themselves); otherwise, migrations will not perform as expected.{{< /alert >}}
3333

3434
## OpenNebula Configuration
3535

@@ -39,11 +39,11 @@ Once the Hosts and Front-end storage is set up, configuring OpenNebula comprises
3939

4040
To create a new System Datastore, you need to set the following (template) parameters:
4141

42-
| Attribute | Description |
43-
|-------------|-------------------|
44-
| `NAME` | Name of datastore |
45-
| `TYPE` | `SYSTEM_DS` |
46-
| `TM_MAD` | `local` |
42+
| Attribute | Description |
43+
| --------- | ----------------- |
44+
| `NAME` | Name of datastore |
45+
| `TYPE` | `SYSTEM_DS` |
46+
| `TM_MAD` | `local` |
4747

4848
You can do this either in Sunstone or through the CLI; for example, to create a local System Datastore simply enter:
4949

@@ -58,18 +58,18 @@ ID: 101
5858
```
5959

6060
{{< alert title="Note" color="success" >}}
61-
When different System Datastores are available, the `TM_MAD_SYSTEM` attribute will be set after selecting the Datastore.{{< /alert >}}
61+
When different System Datastores are available, select one to have the the `TM_MAD_SYSTEM` attribute set.{{< /alert >}}
6262

6363
### Create Image Datastore
6464

6565
To create a new Image Datastore, you need to set the following (template) parameters:
6666

67-
| Attribute | Description |
68-
|-------------|----------------------------------------------------------|
69-
| `NAME` | Name of datastore |
70-
| `DS_MAD` | `fs` |
71-
| `TM_MAD` | `local` |
72-
| `CONVERT` | `yes` (default) or `no`. Change Image format to `DRIVER` |
67+
| Attribute | Description |
68+
| --------- | -------------------------------------------------------- |
69+
| `NAME` | Name of datastore |
70+
| `DS_MAD` | `fs` |
71+
| `TM_MAD` | `local` |
72+
| `CONVERT` | `yes` (default) or `no`. Change Image format to `DRIVER` |
7373

7474
For example, the following illustrates the creation of a Local Datastore:
7575

@@ -86,20 +86,20 @@ ID: 100
8686
Also note that there are additional attributes that can be set. Check the [datastore template attributes]({{% relref "datastores#datastore-common" %}}).
8787

8888
{{< alert title="Warning" color="warning" >}}
89-
Be sure to use the same `TM_MAD` for both the System and Image datastores. When combining different transfer modes, check the section below.{{< /alert >}}
89+
Be sure to use the same `TM_MAD` for both the System and Image datastores. When combining different transfer modes, check the section below.{{< /alert >}}
9090

9191
### Additional Configuration
9292

93-
* `DD_BLOCK_SIZE`: Block size for dd operations (default: 64kB). Can be set in `/var/lib/one/remotes/etc/datastore/fs/fs.conf`.
94-
* `SUPPORTED_FS`: Comma-separated list of every filesystem supported for creating formatted datablocks. Can be set in `/var/lib/one/remotes/etc/datastore/datastore.conf`.
95-
* `FS_OPTS_<FS>`: Options for creating the filesystem for formatted datablocks. Can be set in `/var/lib/one/remotes/etc/datastore/datastore.conf` for each filesystem type.
96-
* `SPARSE`: If set to `NO` the images and disks in the image and system Datastore, respectively, will not be sparsed (i.e. the files will use all assigned space on the Datastore filesystem).
93+
- `DD_BLOCK_SIZE`: Block size for dd operations (default: 64kB). Configured in `/var/lib/one/remotes/etc/datastore/fs/fs.conf`.
94+
- `SUPPORTED_FS`: Comma-separated list of every filesystem supported for creating formatted datablocks. Configured in `/var/lib/one/remotes/etc/datastore/datastore.conf`.
95+
- `FS_OPTS_<FS>`: Options for creating the filesystem for formatted datablocks. Configured in `/var/lib/one/remotes/etc/datastore/datastore.conf` for each filesystem type.
96+
- `SPARSE`: When the value is `NO`, the images and disks in the image and System Datastore, respectively, will not be sparsed (i.e. the files will use all assigned space on the Datastore filesystem).
9797

9898
{{< alert title="Warning" color="warning" >}}
9999
Before adding a new filesystem to the `SUPPORTED_FS` list make sure that the corresponding `mkfs.<fs_name>` command is available in the Front-end and hypervisor Hosts. If an unsupported FS is used by the user the default one will be used.{{< /alert >}}
100100

101101
{{< alert title="Note" color="success" >}}
102-
When using a Local Storage Datastore the `QCOW2_OPTIONS` attribute is ignored since the cloning script uses the `tar` command instead of `qemu-img`.{{< /alert >}}
102+
When using a Local Storage Datastore, the `QCOW2_OPTIONS` attribute is ignored because the cloning script uses the `tar` command instead of `qemu-img`.{{< /alert >}}
103103

104104
## Datastore Drivers
105105

@@ -152,15 +152,14 @@ The distributed cache maintains VM disk images in two levels:
152152

153153
2. **Central (Upstream) Cache**: One or more “central” cache nodes (typically the hosts with the most resources) maintain a larger pool of images shared by the entire cluster.
154154

155-
When a VM is instantiated, the Host first checks its *local cache* for the needed image. If missing, it then checks the *central cache*. Only if the image is not found in either cache does the Host request it from the Image Datastore on the Front-end. Once retrieved from the Front-end, the image is stored in both caches for future reuse.
155+
When a VM is instantiated, the Host first checks its _local cache_ for the needed image. If missing, it then checks the _central cache_. Only if the image is not found in either cache does the Host request it from the Image Datastore on the Front-end. Once retrieved from the Front-end, the image is stored in both caches for future reuse.
156156

157157
![><](/images/local_ds_cache.png)
158158

159159
## How to Enable and Configure the Cache
160160

161161
The Cache is configured per **Image Datastore**. In other words, each Image Datastore in OpenNebula that uses the local TM driver defines its own cache settings. The cache settings are described in the next table:
162162

163-
164163
| Attribute | Description | Deault value |
165164
|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------|
166165
| `CACHE_ENABLE` | Set to `yes` to enable the distributed cache for this Image Datastore, or `no` to disable it. | `NO` |
@@ -169,7 +168,6 @@ The Cache is configured per **Image Datastore**. In other words, each Image Data
169168
| `CACHE_UPSTREAMS` | Comma-separated list of one or more “central” cache hostnames or IPs (e.g., `'hostname0,hostname1'`). Leave empty (`''`) to disable central caches. | `''` (no upstreams) |
170169
| `CACHE_MIN_AGE` | Minimum age in seconds before a cached image can be evicted. For example, "3600" means that any image used within the last hour cannot be removed from cache. | `900` |
171170

172-
173171
For example, to configure a Distributed Cache update the image datastore template with the following parameters:
174172

175173
```default
@@ -180,6 +178,10 @@ CACHE_UPSTREAMS = "hostname0,hostname2"
180178
CACHE_MIN_AGE = "900"
181179
```
182180

181+
When you create a new Datastore, configure these settings through Sunstone .
182+
183+
![sunstone_ds_cache_config](/images/sunstone_ds_cache_config.png)
184+
183185
{{< alert title="Note" color="success" >}}
184186
For the distributed cache to work, the `oneadmin` user (see [Node installation]({{% relref "../../../product/operation_references/hypervisor_configuration" %}})) must have SSH passwordless authentication configured on all Hosts.{{< /alert >}}
185187

0 commit comments

Comments
 (0)