You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: MIGRATING.md
+103-42
Original file line number
Diff line number
Diff line change
@@ -14,48 +14,109 @@ All playbooks using the Ansible roles provided by this project need to adapt thi
14
14
15
15
The following steps need to be taken in order to consume the `main` branch in your own projects:
16
16
17
-
- Repository contents need to be placed in a `collections/ansible_collections/ibm/spectrum_scale` directory, adjacent to your playbooks. The easiest way to do this is to clone the correct branch into the appropriate path:
18
-
19
-
```shell
20
-
$ git clone -b main https://github.com/IBM/ibm-spectrum-scale-install-infra.git collections/ansible_collections/ibm/spectrum_scale
21
-
```
22
-
23
-
The resulting directory structure should look similar to this:
24
-
25
-
```shell
26
-
my_project/
27
-
├── collections/
28
-
│ └── ansible_collections/
29
-
│ └── ibm/
30
-
│ └── spectrum_scale/
31
-
│ └── ...
32
-
├── hosts
33
-
└── playbook.yml
34
-
```
35
-
36
-
- Once the repository contents are available in the appropriate path, roles can be referenced by using their Fully Qualified Collection Name (FQCN). A minimal playbook should look similar to this:
37
-
38
-
```yaml
39
-
# playbook.yml:
40
-
---
41
-
- hosts: cluster01
42
-
roles:
43
-
- ibm.spectrum_scale.core_prepare
44
-
- ibm.spectrum_scale.core_install
45
-
- ibm.spectrum_scale.core_configure
46
-
- ibm.spectrum_scale.core_verify
47
-
```
48
-
49
-
Refer to the [Ansible User Guide](https://docs.ansible.com/ansible/latest/user_guide/collections_using.html#using-collections-in-a-playbook) for details on using collections, including alternate syntax with the `collections` keyword.
50
-
51
-
Note that all role names have changed:
52
-
53
-
- Old naming: `[component]/[precheck|node|cluster|postcheck]`
54
-
- New naming: `[component]_[prepare|install|configure|verify]`
55
-
56
-
Refer to the examples in the [samples/](samples/) directory for a list of new role names.
57
-
58
-
- Some variables have been renamed for consistency as well, but it's expected that these changes only affect very few users. See [#590](https://github.com/IBM/ibm-spectrum-scale-install-infra/pull/590) for details, and refer to [VARIABLESNEW.md](VARIABLESNEW.md) for a complete listing of all available variables.
17
+
- Repository contents need to be placed in a `collections/ansible_collections/ibm/spectrum_scale` directory, adjacent to your playbooks. The easiest way to do this is to clone the correct branch into the appropriate path:
18
+
19
+
```shell
20
+
$ git clone -b main https://github.com/IBM/ibm-spectrum-scale-install-infra.git collections/ansible_collections/ibm/spectrum_scale
21
+
```
22
+
23
+
The resulting directory structure should look similar to this:
24
+
25
+
```shell
26
+
my_project/
27
+
├── collections/
28
+
│ └── ansible_collections/
29
+
│ └── ibm/
30
+
│ └── spectrum_scale/
31
+
│ └── ...
32
+
├── hosts
33
+
└── playbook.yml
34
+
```
35
+
36
+
- Once the repository contents are available in the appropriate path, roles can be referenced by using their Fully Qualified Collection Name (FQCN). A minimal playbook should look similar to this:
37
+
38
+
```yaml
39
+
# playbook.yml:
40
+
---
41
+
- hosts: cluster01
42
+
roles:
43
+
- ibm.spectrum_scale.core_prepare
44
+
- ibm.spectrum_scale.core_install
45
+
- ibm.spectrum_scale.core_configure
46
+
- ibm.spectrum_scale.core_verify
47
+
```
48
+
49
+
Refer to the [Ansible User Guide](https://docs.ansible.com/ansible/latest/user_guide/collections_using.html#using-collections-in-a-playbook) for details on using collections, including alternate syntax with the `collections` keyword.
50
+
51
+
Note that all role names have changed:
52
+
53
+
- Old naming: `[component]/[precheck|node|cluster|postcheck]`
54
+
- New naming: `[component]_[prepare|install|configure|verify]`
55
+
56
+
Refer to the [name mapping table](#role-name-mapping-table) for a list of new role names.
57
+
58
+
- Some variables have been renamed for consistency as well, but it's expected that these changes only affect very few users. See [#590](https://github.com/IBM/ibm-spectrum-scale-install-infra/pull/590) for details, and refer to [VARIABLESNEW.md](VARIABLESNEW.md) for a complete listing of all available variables.
0 commit comments