Skip to content

Commit 4246d37

Browse files
authored
docs: update module block in main README (#82)
* docs: update module block in main README move iSCSI Block Volumes related information to a dedicated documentation page * fix: iscsiadm link targets the relevant line of code
1 parent 5493523 commit 4246d37

File tree

2 files changed

+47
-7
lines changed

2 files changed

+47
-7
lines changed

README.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,8 @@ module "instance" {
5454
ssh_public_keys = var.ssh_public_keys
5555
block_storage_sizes_in_gbs = [50]
5656
shape = var.shape
57+
instance_state = var.instance_state # RUNNING or STOPPED
58+
boot_volume_backup_policy = var.boot_volume_backup_policy # disabled, gold, silver or bronze
5759
}
5860
```
5961

@@ -63,13 +65,7 @@ The current focus is to close the gap between this module and the provider's cap
6365

6466
We will continue to push in that direction with the goal of [feature parity with the provider's capabilities](https://github.com/oracle-terraform-modules/terraform-oci-compute-instance/projects/4), as well as adding more features and integration points with other OCI services: Block Volume Backups, Secondary VNICs and IPs, etc ...
6567

66-
Given the dependency to Network and Storage for Compute Instances,it is a perfect place to illustrate [module composition principles](https://www.terraform.io/docs/language/modules/develop/composition.html) and how to reuse the other official Terraform OCI modules.
67-
68-
## Configuring iSCSI volume attachments
69-
70-
- For guidance configuring iSCSI on a Windows platform, see [Adding a Block Volume to a Windows Instance](https://docs.cloud.oracle.com/iaas/Content/GSG/Tasks/addingstorageForWindows.htm).
71-
72-
- For guidance configuring iSCSI on a Linux platform, see [iSCSI Commands and Information](https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/iscsiinformation.htm). See also this example of inline iSCSI commands execution using `iscsiadm` CLI called from terraform file: [instance.tf](https://github.com/terraform-providers/terraform-provider-oci/blob/master/examples/compute/instance/instance.tf).
68+
Given the dependency to Network and Storage for Compute Instances, it is a perfect place to illustrate [module composition principles](https://www.terraform.io/docs/language/modules/develop/composition.html) and how to reuse the other official Terraform OCI modules.
7369

7470
## Contributing
7571

docs/iscsi_volume_attachements.adoc

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
= Configuring iSCSI volume attachments
2+
ifdef::env-github[]
3+
:tip-caption: :bulb:
4+
:note-caption: :information_source:
5+
:important-caption: :heavy_exclamation_mark:
6+
:caution-caption: :fire:
7+
:warning-caption: :warning:
8+
endif::[]
9+
:idprefix:
10+
:idseparator: -
11+
:sectlinks:
12+
:toc:
13+
14+
:uri-repo: https://github.com/oracle-terraform-modules/terraform-oci-vcn
15+
:uri-rel-file-base: link:{uri-repo}/blob/main
16+
:uri-rel-tree-base: link:{uri-repo}/tree/main
17+
:uri-docs: {uri-rel-file-base}/docs
18+
:uri-oci-security-credentials: https://docs.oracle.com/en-us/iaas/Content/General/Concepts/credentials.htm#Instance
19+
:uri-oci-core-instance: https://registry.terraform.io/providers/hashicorp/oci/latest/docs/resources/core_instance#metadata
20+
:uri-tf-heredoc: https://www.terraform.io/docs/language/expressions/strings.html#heredoc-strings
21+
:uri-tf-file-function: https://www.terraform.io/docs/language/functions/file.html
22+
:uri-adding-bv-linux: https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/iscsiinformation.htm
23+
:uri-adding-bv-windows: https://docs.cloud.oracle.com/iaas/Content/GSG/Tasks/addingstorageForWindows.htm
24+
:uri-inline-iscsi-cmd: https://github.com/terraform-providers/terraform-provider-oci/blob/afe6f577b70e24c31c8bcddf6a3750d6b0f9e74c/examples/compute/instance/instance.tf#L204
25+
:uri-tf-remote-exec: https://www.terraform.io/docs/language/resources/provisioners/remote-exec.html
26+
:uri-oci-ocid-daemon: https://docs.oracle.com/en-us/iaas/Content/Compute/References/ocid.htm
27+
28+
If you attach additional Block Volumes to your compute instance with an attachement type `iSCSI`, the operating system needs to be aware of this new device before it can be used.
29+
30+
There is two methods for that:
31+
32+
- configuring the device manually with the operating system tools,
33+
- automatically configure the device using an OCI helper: `ocid` daemon.
34+
35+
== Configuring additional devices manually
36+
37+
- For guidance on configuring iSCSI on a Windows platform, see {uri-adding-bv-windows}[Adding a Block Volume to a Windows Instance].
38+
- For guidance on configuring iSCSI on a Linux platform, see {uri-adding-bv-linux}[iSCSI Commands and Information]. See also this example on the oci provider documentation of {uri-inline-iscsi-cmd}[inline iSCSI commands execution using iscsiadm CLI] using a {uri-tf-remote-exec}[Terraform remote-exec].
39+
40+
== Configuration additional devices automatically
41+
42+
The `ocid` daemon is the service component of the `oci-utils`. It monitors for changes in the VNIC and iSCSI configuration of the instance and attempts to automatically attach or detach devices as they appear or disappear - for example, when they are created or deleted using the Oracle Cloud Infrastructure Console, CLI, or the API.
43+
44+
See {uri-oci-ocid-daemon}[the ocid daemon documentation] for more details.

0 commit comments

Comments
 (0)