-
Notifications
You must be signed in to change notification settings - Fork 66
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
We want to add more workloads (stalefulset, daemonset), more storage (CephFS), and the new OCM discovered applications. Each variant require specific instructions or example commands so it is best done using one file per variant, where you can experiment with complete disaster recovery flow for a single variant. - Move the content we had in the main README.md to `docs/initial-setup.md` and `docs/ocm-rbd.md` - Move the content we had in `workloads/kubevirt/README.md` to `docs/ovm-kubevirt.md`. - Add `docs/create-environment.md` with short instructions how to create a testing environment for playing with the samples in this repo. - Change `README.md` to a short overview linking to all other documents. The new docs directory can be used next to create more structure documentation like https://docs.readthedocs.io. Signed-off-by: Nir Soffer <[email protected]>
- Loading branch information
Showing
6 changed files
with
781 additions
and
538 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,171 +1,24 @@ | ||
| # ocm-ramen-samples | ||
|
|
||
| OCM Stateful application samples, including Ramen resources. | ||
| OCM Stateful application samples, including *Ramen* resources. | ||
|
|
||
| ## Initial setup | ||
|
|
||
| 1. Clone this git repository to get started: | ||
|
|
||
| ``` | ||
| git clone https://github.com/RamenDR/ocm-ramen-samples.git | ||
| cd ocm-ramen-samples | ||
| ``` | ||
|
|
||
| 1. Switch kubeconfig to point to the OCM Hub cluster | ||
|
|
||
| ``` | ||
| kubectl config use-context hub | ||
| ``` | ||
|
|
||
| 1. Create DRClusters and DRPolicy | ||
|
|
||
| When using the ramen testing environment this is not needed, but if | ||
| you are using your own Kubernetes clusters you need to create the | ||
| resources. | ||
|
|
||
| Modify the DRCluster and DRpolicy resources in the `ramen` directory | ||
| to match the actual cluster names in your environment, and apply | ||
| the kustomization: | ||
|
|
||
| ``` | ||
| kubectl apply -k ramen | ||
| ``` | ||
|
|
||
| This creates DRPolicy and DRCluster resources in the cluster | ||
| namespace that can be viewed using: | ||
|
|
||
| ``` | ||
| kubectl get drcluster,drpolicy | ||
| ``` | ||
|
|
||
| 1. Setup the common OCM channel resources on the hub: | ||
|
|
||
| ``` | ||
| kubectl apply -k channel | ||
| ``` | ||
|
|
||
| This creates a Channel resource in the `ramen-samples` namespace and | ||
| can be viewed using: | ||
|
|
||
| ``` | ||
| kubectl get channel ramen-gitops -n ramen-samples | ||
| ``` | ||
|
|
||
| ## Sample applications | ||
|
|
||
| In the workloads directory provides samples that can be deployed on | ||
| Kubernetes and OpenShift. | ||
|
|
||
| - deployment - busybox deployment | ||
| - kubevirt | ||
| - vm-pvc - PVC based VM | ||
| - vm-dv - DataVolume based VM | ||
| - vm-dvt - DataVolumeTemplate based VM | ||
|
|
||
| ## Deploying a sample application | ||
|
|
||
| In the example we use the busybox deployment for Kubernetes regional DR | ||
| environment using RBD storage: | ||
|
|
||
| subscription/deployment-k8s-regional-rbd | ||
|
|
||
| This application is deployed in the `deployment-rbd` namespace on the | ||
| hub and managed clusters. | ||
|
|
||
| You can use other overlays to deploy on other cluster types or use | ||
| different storage class. You can also create your own overlays based on | ||
| the examples. | ||
|
|
||
| 1. Deploy an OCM application subscription on hub: | ||
| ## Create an environment | ||
|
|
||
| ``` | ||
| kubectl apply -k subscription/deployment-k8s-regional-rbd | ||
| ``` | ||
| The easiest way to start is to use the *Ramen* testing environment | ||
| created by the *drenv* tool. See | ||
| [create environment](create-environment.md) to learn how to | ||
| quickly create a your disaster recovery playground. | ||
|
|
||
| This creates the required Subscription, Placement, and | ||
| ManagedClusterSetBinding resources for the deployment in the | ||
| `deployment-rbd` namespace and can be viewed using: | ||
|
|
||
| ``` | ||
| kubectl get subscription,placement -n deployment-rbd | ||
| ``` | ||
|
|
||
| 1. Inspect subscribed resources from the channel created in the same | ||
| namespace on the ManagedCluster selected by the Placement. | ||
|
|
||
| The busybox deployment Placement `status` can be viewed on the hub | ||
| using: | ||
|
|
||
| ``` | ||
| kubectl get placement placement -n deployment-rbd | ||
| ``` | ||
|
|
||
| The Busybox deployment subscribed resources, like the pod and the PVC | ||
| can be viewed on the ManagedCluster using (example ManagedCluster | ||
| `dr1`): | ||
|
|
||
| ``` | ||
| kubectl get pod,pvc -n deployment-rbd --context dr1 | ||
| ``` | ||
|
|
||
| ## Undeploying a sample application | ||
|
|
||
| To undeploy an application delete the subscription overlay used to | ||
| deploy the application: | ||
|
|
||
| ``` | ||
| kubectl delete -k subscription/deployment-k8s-regional-rbd | ||
| ``` | ||
|
|
||
| ## Enable DR for a deployed application | ||
|
|
||
| 1. Change the Placement to be reconciled by Ramen | ||
|
|
||
| ``` | ||
| kubectl annotate placement placement -n deployment-rbd \ | ||
| cluster.open-cluster-management.io/experimental-scheduling-disable=true | ||
| ``` | ||
|
|
||
| 1. Deploy a DRPlacementControl resource for the OCM application on the | ||
| hub, for example: | ||
|
|
||
| ``` | ||
| kubectl apply -k dr/deployment-k8s-regional-rbd | ||
| ``` | ||
|
|
||
| This creates a DRPlacementControl resource for the busybox deployment | ||
| in the `deployment-rbd` namespace and can be viewed using: | ||
|
|
||
| ``` | ||
| kubectl get drpc -n deployment-rbd | ||
| ``` | ||
|
|
||
| At this point the placement of the application is managed by *Ramen*. | ||
|
|
||
| ## Disable DR for a DR enabled application | ||
|
|
||
| 1. Ensure the placement is pointing to the cluster where the workload is | ||
| currently placed to avoid data loss if OCM moves the application to | ||
| another cluster. | ||
|
|
||
| The sample `placement` does not require any change, but if you are | ||
| using an application created by OpenShift Console, you may need to | ||
| change the cluster name in the placement. | ||
|
|
||
| 1. Delete the drpc resource for the OCM application on the hub: | ||
|
|
||
| ``` | ||
| kubectl delete -k dr/deployment-k8s-regional-rbd | ||
| ``` | ||
| ## Initial setup | ||
|
|
||
| This deletes the DRPlacementControl resource for the busybox | ||
| deployment, disabling replication and removing replicated data. | ||
| Before experimenting with disaster recovery we need to configure the | ||
| clusters. See [initial setup](docs/initial-setup.md) to learn how to set | ||
| up your environment. | ||
|
|
||
| 1. Change the Placement to be reconciled by OCM | ||
| ## Experiments | ||
|
|
||
| ``` | ||
| kubectl annotate placement placement -n deployment-rbd \ | ||
| cluster.open-cluster-management.io/experimental-scheduling-disable- | ||
| ``` | ||
| After setting up your environment you can experiments with various | ||
| workloads and storage types: | ||
|
|
||
| At this point the application is managed again by *OCM*. | ||
| - Experiment with *OCM* managed [deployment](docs/ocm-rbd.md) | ||
| - Experiment with *OCM* managed [virtual machine](docs/ocm-kubevirt.md) |
Oops, something went wrong.