diff --git a/README.md b/README.md index 822a0c2b..b7fedaa0 100644 --- a/README.md +++ b/README.md @@ -82,7 +82,7 @@ active-passive scenarios. ``` 8. Verify the Framework's _GitOps_ server:
- + 9. Observe the Pattern's _GitOps_ server and wait for all resources to be reconciled. @@ -90,13 +90,13 @@ active-passive scenarios. > some time. 10. In [ACM][acm]'s UI, verify _Submariner_ is healthy:
- + 11. In [ACM][acm]'s UI, verify the _Managed Clusters_ are healthy:
- + 12. In the _Hub_'s UI, verify the _DR Policies_ are validated match your requirements:
- + 13. For every _Managed Cluster_, obtain the [RedHat GitOps][gitops] routes, and access them. There are two different servers. One for the _Pattern Framework_ and one for our _Pattern Instance_: @@ -110,10 +110,10 @@ active-passive scenarios. ``` 14. For every _Managed Cluster_, verify the Framework's _GitOps_ server:
- + 15. For every _Managed Cluster_, verify the Pattern's _GitOps_ server:
- + All Done.
Get started deploying _DR Applications_ with the [Regional DR][regional] docs and the @@ -130,15 +130,15 @@ by [ACM][acm]'s heartbeat mechanism, a failover will be triggered to all related [acm]: https://www.redhat.com/en/technologies/management/advanced-cluster-management [devsecops]: https://validatedpatterns.io/patterns/devsecops/ -[example-app]: https://github.com/RHEcosystemAppEng/regional-resiliency-pattern/blob/main/doc/ExampleDRApp.md +[example-app]: https://github.com/RHEcosystemAppEng/regional-resiliency-pattern/blob/main/docs/ExampleDRApp.md [install_config]: https://docs.openshift.com/container-platform/4.14/installing/installing_aws/installing-aws-customizations.html [gitops]: https://www.redhat.com/en/technologies/cloud-computing/openshift/gitops -[maintenance]: https://github.com/RHEcosystemAppEng/regional-resiliency-pattern/blob/main/doc/Maintenance.md +[maintenance]: https://github.com/RHEcosystemAppEng/regional-resiliency-pattern/blob/main/docs/Maintenance.md [oc]: https://docs.openshift.com/container-platform/4.14/cli_reference/openshift_cli/getting-started-cli.html [odf]: https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation/4.14 [openshift]: https://www.redhat.com/en/technologies/cloud-computing/openshift [rdrtrigger]: https://github.com/RHEcosystemAppEng/regional-dr-trigger-operator-chart [regional]: https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation/4.14/html/configuring_openshift_data_foundation_disaster_recovery_for_openshift_workloads/rdr-solution -[troubleshooting]: https://github.com/RHEcosystemAppEng/regional-resiliency-pattern/blob/main/doc/Troubleshooting.md -[uninstalling]: https://github.com/RHEcosystemAppEng/regional-resiliency-pattern/blob/main/doc/Uninstalling.md +[troubleshooting]: https://github.com/RHEcosystemAppEng/regional-resiliency-pattern/blob/main/docs/Troubleshooting.md +[uninstalling]: https://github.com/RHEcosystemAppEng/regional-resiliency-pattern/blob/main/docs/Uninstalling.md [vp]: https://validatedpatterns.io/ diff --git a/doc/ExampleDRApp.md b/docs/ExampleDRApp.md similarity index 100% rename from doc/ExampleDRApp.md rename to docs/ExampleDRApp.md diff --git a/doc/Maintenance.md b/docs/Maintenance.md similarity index 100% rename from doc/Maintenance.md rename to docs/Maintenance.md diff --git a/doc/Troubleshooting.md b/docs/Troubleshooting.md similarity index 84% rename from doc/Troubleshooting.md rename to docs/Troubleshooting.md index 8386d72f..e809a0c3 100644 --- a/doc/Troubleshooting.md +++ b/docs/Troubleshooting.md @@ -10,10 +10,10 @@ If not in production, you may opt for a third-party solution, such as _Let's Enc _Acme Operator_. Just update the _S3_ Route with the new trustable certificate. Check for certificate issues in your _DR Policy_ resources:
- + And in the underlying _DR Cluster_ resources:
- + [odf]: https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation/4.14 [regional]: https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation/4.14/html/configuring_openshift_data_foundation_disaster_recovery_for_openshift_workloads/rdr-solution diff --git a/doc/Uninstalling.md b/docs/Uninstalling.md similarity index 100% rename from doc/Uninstalling.md rename to docs/Uninstalling.md diff --git a/doc/clusters.png b/docs/clusters.png similarity index 100% rename from doc/clusters.png rename to docs/clusters.png diff --git a/doc/drcluster-certificate-err.png b/docs/drcluster-certificate-err.png similarity index 100% rename from doc/drcluster-certificate-err.png rename to docs/drcluster-certificate-err.png diff --git a/doc/drpolicies.png b/docs/drpolicies.png similarity index 100% rename from doc/drpolicies.png rename to docs/drpolicies.png diff --git a/doc/drpolicy-certificate-err.png b/docs/drpolicy-certificate-err.png similarity index 100% rename from doc/drpolicy-certificate-err.png rename to docs/drpolicy-certificate-err.png diff --git a/doc/hub-framework-gitops.png b/docs/hub-framework-gitops.png similarity index 100% rename from doc/hub-framework-gitops.png rename to docs/hub-framework-gitops.png diff --git a/doc/mc-framework-gitops.png b/docs/mc-framework-gitops.png similarity index 100% rename from doc/mc-framework-gitops.png rename to docs/mc-framework-gitops.png diff --git a/doc/mc-pattern-gitops.png b/docs/mc-pattern-gitops.png similarity index 100% rename from doc/mc-pattern-gitops.png rename to docs/mc-pattern-gitops.png diff --git a/doc/rdr-example-app-images/dr-hub-cr-status.png b/docs/rdr-example-app-images/dr-hub-cr-status.png similarity index 100% rename from doc/rdr-example-app-images/dr-hub-cr-status.png rename to docs/rdr-example-app-images/dr-hub-cr-status.png diff --git a/doc/rdr-example-app-images/drpc-deployed.png b/docs/rdr-example-app-images/drpc-deployed.png similarity index 100% rename from doc/rdr-example-app-images/drpc-deployed.png rename to docs/rdr-example-app-images/drpc-deployed.png diff --git a/doc/rdr-example-app-images/drpc-failedover.png b/docs/rdr-example-app-images/drpc-failedover.png similarity index 100% rename from doc/rdr-example-app-images/drpc-failedover.png rename to docs/rdr-example-app-images/drpc-failedover.png diff --git a/doc/rdr-example-app-images/drpc-failingover.png b/docs/rdr-example-app-images/drpc-failingover.png similarity index 100% rename from doc/rdr-example-app-images/drpc-failingover.png rename to docs/rdr-example-app-images/drpc-failingover.png diff --git a/doc/rdr-example-app-images/pacman-after-dr.png b/docs/rdr-example-app-images/pacman-after-dr.png similarity index 100% rename from doc/rdr-example-app-images/pacman-after-dr.png rename to docs/rdr-example-app-images/pacman-after-dr.png diff --git a/doc/rdr-example-app-images/pacman-first-play.png b/docs/rdr-example-app-images/pacman-first-play.png similarity index 100% rename from doc/rdr-example-app-images/pacman-first-play.png rename to docs/rdr-example-app-images/pacman-first-play.png diff --git a/doc/rdr-example-app-images/pacman-results.png b/docs/rdr-example-app-images/pacman-results.png similarity index 100% rename from doc/rdr-example-app-images/pacman-results.png rename to docs/rdr-example-app-images/pacman-results.png diff --git a/doc/rdr-example-app/01-namespaces.yaml b/docs/rdr-example-app/01-namespaces.yaml similarity index 100% rename from doc/rdr-example-app/01-namespaces.yaml rename to docs/rdr-example-app/01-namespaces.yaml diff --git a/doc/rdr-example-app/02-pacman-acm-app.yaml b/docs/rdr-example-app/02-pacman-acm-app.yaml similarity index 100% rename from doc/rdr-example-app/02-pacman-acm-app.yaml rename to docs/rdr-example-app/02-pacman-acm-app.yaml diff --git a/doc/rdr-example-app/03-drpc.yaml b/docs/rdr-example-app/03-drpc.yaml similarity index 100% rename from doc/rdr-example-app/03-drpc.yaml rename to docs/rdr-example-app/03-drpc.yaml diff --git a/doc/submariner.png b/docs/submariner.png similarity index 100% rename from doc/submariner.png rename to docs/submariner.png