Skip to content

Commit 90e2041

Browse files
committed
feat: moved new doc to ./doc/user/ to match convention
Signed-off-by: Caroline Baldauff <caroline.baldauff@sas.com>
1 parent 84beb18 commit 90e2041

File tree

4 files changed

+7
-7
lines changed

4 files changed

+7
-7
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ This project contains Ansible code that creates a baseline cluster in an existin
4444
- Deploy [aws-ebs-csi-driver](https://github.com/kubernetes-sigs/aws-ebs-csi-driver) (AWS only)
4545
- Manage storageClass settings
4646

47-
*NOTE*: See the list of [supported third-party components](./docs/third-party-components.md) for more information. For information on networking considerations for these and other components, see [networking considerations](./docs/networking-considerations.md).
47+
*NOTE*: See the list of [supported third-party components](./docs/third-party-components.md) for more information. For information on networking considerations for these and other components, see [networking considerations](./docs/user/NetworkingConsiderations.md).
4848

4949
- Deploy the SAS Viya Platform
5050
- Retrieve the deployment assets using [SAS Viya Orders CLI](https://github.com/sassoftware/viya4-orders-cli)
File renamed without changes.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
### Third-party components
1+
### Third-Party Components
22
The following is a list of the third-party components currently in full support/used by the Viya4 DaC. You can also find the chart repo URLs referenced in the repo [README](../README.md).
33

44
| Component | Chart Name | Chart Source URL | Container Registry | Purpose | Cloud Provider Support |

playbooks/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,21 +23,21 @@
2323
- Action: Includes the `jump-server` role.
2424
- Condition: Runs only if all of these are defined: `JUMP_SVR_HOST`, `JUMP_SVR_USER`, `JUMP_SVR_PRIVATE_KEY`, `V4_CFG_MANAGE_STORAGE` and if `V4_CFG_MANAGE_STORAGE` is `true`.
2525
- Tags: `viya`
26-
- **Networking Considerations:** May require SSH access to the jump server and NFS server. See [networking-considerations.md](../docs/networking-considerations.md)
26+
- **Networking Considerations:** May require SSH access to the jump server and NFS server. See [NetworkingConsiderations.md](../docs/user/NetworkingConsiderations.md)
2727
5. **Optionally Include Baseline Role for Install**
2828

2929
- Task: `baseline role install`
3030
- Action: Includes the `baseline` role for install actions.
3131
- Condition: Runs only if both `'baseline'` and `'install'` are in `ansible_run_tags`.
3232
- Tags: `baseline`
33-
- **Networking Considerations:** Deploys core components (ingress-nginx, cert-manager, metrics-server, csi-driver-nfs, ebs-csi-driver, etc.) that impact cluster networking, ingress, and storage. See [networking-considerations.md](../docs/networking-considerations.md)
33+
- **Networking Considerations:** Deploys core components (ingress-nginx, cert-manager, metrics-server, csi-driver-nfs, ebs-csi-driver, etc.) that impact cluster networking, ingress, and storage. See [NetworkingConsiderations.md](../docs/user/NetworkingConsiderations.md)
3434
6. **Optionally Include Multi-Tenancy Role**
3535

3636
- Task: `Multi-tenancy role`
3737
- Action: Includes the `multi-tenancy` role.
3838
- Condition: Runs only if `V4MT_ENABLE` is defined.
3939
- Tags: `multi-tenancy`
40-
- **Networking Considerations:** May create namespaces and network policies. See [networking-considerations.md](../docs/networking-considerations.md)
40+
- **Networking Considerations:** May create namespaces and network policies. See [NetworkingConsiderations.md](../docs/user/NetworkingConsiderations.md)
4141
7. **Include VDM Role**
4242

4343
- Task: `vdm role`
@@ -50,7 +50,7 @@
5050
- Action: Includes the `baseline` role for uninstall actions.
5151
- Condition: Runs only if both `'baseline'` and `'uninstall'` are in `ansible_run_tags`.
5252
- Tags: `baseline`
53-
- **Networking Considerations:** Removes core components and may affect networking and storage resources. See [networking-considerations.md](../docs/networking-considerations.md)
53+
- **Networking Considerations:** Removes core components and may affect networking and storage resources. See [NetworkingConsiderations.md](../docs/user/NetworkingConsiderations.md)
5454
9. **Delete Temporary Directory**
5555

5656
- Task: `Delete tmpdir`
@@ -61,4 +61,4 @@
6161
- Tasks are executed in the order listed above.
6262
- Some tasks/roles are conditionally included based on variables or tags.
6363
- The playbook is designed to be flexible for different deployment scenarios by using tags and conditions.
64-
- For a detailed summary of networking considerations, see [networking-considerations.md](../docs/networking-impact.md)
64+
- For a detailed summary of networking considerations, see [NetworkingConsiderations.md](../docs/user/NetworkingConsiderations.md)

0 commit comments

Comments
 (0)