Docs: Recipe Overview - details usage and S3 behavior #826

tjanssen3 · 2023-04-10T23:15:34Z

No description provided.

ShyamsundarR

@tjanssen3 other than the comment regarding not needing recipe if app needs one big backup/restore of all its resources, this PR is good to be merged. If we can clear that out, we can merge it (and if you prefer the nits can be addressed)

ShyamsundarR · 2023-04-28T14:34:34Z

docs/recipe_overview.md

+* Recipe API managed in a [separate repo](https://github.com/RamenDR/recipe)
+* Recipes utilize Velero under the hood
+    * Many fields are pass-through to create Velero Backup/Restore objects
+* If your application can be backed up and restored as one big group, you don’t


Not sure about this, if there is no recipe ref we do not protect any additional resources is what I see, so a recipe is required?

ShyamsundarR · 2023-04-28T14:35:23Z

docs/recipe_overview.md

+
+Where an application may have issues with Velero:
+
+1. Velero works well when an application can be backed up and restored as a


(nit) link to CP4D product?

ShyamsundarR · 2023-04-28T14:37:22Z

docs/recipe_overview.md

+and Restore objects. Recipes have been omitted for clarity and brevity here.
+
+```bash
+tjanssen@eyewall4:~$ mc du -r minio-cluster1


(nit) remove tjanssen@eyewall4 (and below)

hatfieldbrian · 2023-05-18T17:53:28Z

docs/recipe_overview.md

+name to the `spec.kubeObjectProtection.recipeRef.name` field.
+
+```yaml
+# VRG metadata omitted


I recommend at least putting this line:

kind: VolumeReplicationGroup

hatfieldbrian · 2023-05-18T17:54:02Z

docs/recipe_overview.md

+the resources to restore to the appropriate type.
+
+```yaml
+# metadata omitted


kind: Recipe

hatfieldbrian · 2023-05-18T17:54:28Z

docs/recipe_overview.md

+for PVC Selection, rather than what is defined on the VRG.
+
+```yaml
+# metadata omitted


kind: Recipe

hatfieldbrian · 2023-05-18T17:54:40Z

docs/recipe_overview.md

+show the API only.
+
+```yaml
+# metadata omitted


kind: Recipe

hatfieldbrian · 2023-05-18T18:03:35Z

docs/recipe_overview.md

+spec:
+  groups:
+    - name: instance-resources
+      backupRef: instance-resources


Since this is a restore group I think the backupRef should be omitted for clarity. This option would be removed if capture and recover groups were defined.

hatfieldbrian · 2023-05-18T18:04:55Z

docs/recipe_overview.md

+  name: recipe-busybox
+  namespace: recipe-test
+spec:
+  appType: busybox


What does this appType field do? If nothing, then I suggest omitting. If something, then I suggest explanining it.

hatfieldbrian · 2023-05-18T18:06:07Z

docs/recipe_overview.md

+
+```yaml
+# metadata omitted for example
+# groups, hooks omitted for example


kind: Recipe

- also updated docs/krp.md to reflect removal of CaptureOrder/RecoverOrder structs - added krp_install.md, which details kubeObjectProtection/Recipe setup and configuration - removed recipe.md, which contained old Recipe API, in favor of recipe_overview.md Signed-off-by: Travis Janssen <[email protected]>

hatfieldbrian

Not finished reviewing, but posting some comments

hatfieldbrian · 2023-06-15T23:56:26Z

docs/krp_install.md

+1. S3 store (e.g. Minio/Noobaa) installed and configured
+1. S3 store credentials
+1. Velero/OADP installed and configured
+1. Velero credentials


S3 store credentials and Velero credentials actually have to be the same, but their secret formats differ

(nit) e.g., minio, noobaa i.e., , instead of /

hatfieldbrian · 2023-06-15T23:59:46Z

docs/krp_install.md

+      s3Region: us-east-1
+      s3SecretRef:
+        name: minio-s3
+      VeleroNamespaceSecretKeyRef:


lowercase v: veleroNamespaceSecretKeyRef

hatfieldbrian · 2023-06-16T00:01:35Z

docs/krp_install.md

+For every s3 profile, two Secrets will need to be created: one with s3 credentials,
+one with Velero/OADP credentials. This means for two S3 profiles, four Secrets are


(nit) I'd say credentials are the same, but secret formats differ

hatfieldbrian · 2023-06-16T00:05:01Z

docs/recipe_overview.md

+By default, Kubernetes resources are Captured and Recovered as single, namespaced
+groups. Some applications may require strict ordering by type of resource during
+Capture or Recover to ensure a successful deployment. To provide this flexibility,
+Recipes can be used to describe a Workflow used for a Capture or Recover action.
+These Recipe Workflows can be referenced by the VolumeReplicationGroup (VRG), and
+executed periodically.


(nit) I recommend lowercase capture and recover

(nit) fields names and kinds are good candidates for highlighting by surrounding in backticks. E.g., VolumeReplicationGroup

hatfieldbrian · 2023-06-16T00:24:03Z

docs/recipe_overview.md

+1. What is a Recipe and why do we need it?
+1. Recipe concepts
+1. Sample application that uses a Recipe
+1. Additional details on Recipe functionality
+1. Where to go to learn more


(nit) Section links would be nice
https://stackoverflow.com/questions/2822089/how-to-link-to-part-of-the-same-document-in-markdown
https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#section-links

(nit) If uppercase Recipe, then I recommend surrounding in backticks, else I recommend lowercase r

hatfieldbrian · 2023-06-16T00:26:51Z

docs/recipe_overview.md

+executed periodically.
+
+Recipe source code and additional information can be found [here](https://github.com/RamenDR/recipe).
+The current Recipe CRD can be found [here](https://github.com/RamenDR/recipe/blob/main/config/crd/bases/ramendr.openshift.io_recipes.yaml).


(nit) I recommend the raw link for easy downloading

hatfieldbrian · 2023-06-16T00:29:55Z

docs/recipe_overview.md

+* If your application can be backed up and restored without specific sequencing,
+  a Recipe may not not be required.


(nit) backed up and restored -> captured and recovered
(nit) drop period at end since bulleted list

hatfieldbrian · 2023-06-16T00:36:08Z

docs/krp_install.md

I recommend merging this krp.md file or at least linking it from there

hatfieldbrian · 2023-06-16T00:38:09Z

docs/recipe_overview.md

I recall a suggestion to store recipe documentation in the recipe repo. I understand recipe processing is done in the VRG controller which is in this repo, but the docs should probably just say what it should do based on the API not how it does it

tjanssen3 force-pushed the recipe_documentation branch from bce7e5c to c44d661 Compare April 26, 2023 18:59

tjanssen3 marked this pull request as ready for review April 26, 2023 19:06

tjanssen3 force-pushed the recipe_documentation branch from c44d661 to b210069 Compare April 26, 2023 19:31

ShyamsundarR reviewed Apr 28, 2023

View reviewed changes

tjanssen3 force-pushed the recipe_documentation branch 2 times, most recently from 05cba77 to 0a8e473 Compare May 9, 2023 17:05

hatfieldbrian reviewed May 18, 2023

View reviewed changes

tjanssen3 mentioned this pull request May 22, 2023

Remove backup slot number, 0 or 1, from Velero Backup request name #872

Draft

tjanssen3 force-pushed the recipe_documentation branch from 0a8e473 to 52d2df4 Compare June 13, 2023 00:14

tjanssen3 force-pushed the recipe_documentation branch from 52d2df4 to 9b1d2f5 Compare June 13, 2023 00:18

hatfieldbrian reviewed Jun 16, 2023

View reviewed changes

tjanssen3 mentioned this pull request Jul 12, 2023

Add regional dr environment without a hub #907

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs: Recipe Overview - details usage and S3 behavior #826

Docs: Recipe Overview - details usage and S3 behavior #826

tjanssen3 commented Apr 10, 2023

ShyamsundarR left a comment

ShyamsundarR Apr 28, 2023

ShyamsundarR Apr 28, 2023

ShyamsundarR Apr 28, 2023

hatfieldbrian May 18, 2023

hatfieldbrian May 18, 2023

hatfieldbrian May 18, 2023

hatfieldbrian May 18, 2023

hatfieldbrian May 18, 2023

hatfieldbrian May 18, 2023

hatfieldbrian May 18, 2023

hatfieldbrian left a comment

hatfieldbrian Jun 15, 2023

hatfieldbrian Jun 15, 2023

hatfieldbrian Jun 15, 2023

hatfieldbrian Jun 16, 2023

hatfieldbrian Jun 16, 2023

hatfieldbrian Jun 16, 2023

hatfieldbrian Jun 16, 2023

hatfieldbrian Jun 16, 2023

hatfieldbrian Jun 16, 2023

hatfieldbrian Jun 16, 2023

hatfieldbrian Jun 16, 2023

hatfieldbrian Jun 16, 2023


		Where an application may have issues with Velero:

		1. Velero works well when an application can be backed up and restored as a

		For every s3 profile, two Secrets will need to be created: one with s3 credentials,
		one with Velero/OADP credentials. This means for two S3 profiles, four Secrets are

		* If your application can be backed up and restored without specific sequencing,
		a Recipe may not not be required.

Docs: Recipe Overview - details usage and S3 behavior #826

Are you sure you want to change the base?

Docs: Recipe Overview - details usage and S3 behavior #826

Conversation

tjanssen3 commented Apr 10, 2023

ShyamsundarR left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hatfieldbrian left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment