-
Notifications
You must be signed in to change notification settings - Fork 1.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add doc changes for 0.7.0 #313
Conversation
9354171
to
9704de8
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Initial set of comments, still reviewing
README.md
Outdated
|
||
* **Cross-cloud-provider migration** for Kubernetes API objects (cross-cloud-provider migration of persistent volume snapshots not yet supported) | ||
* Manage disaster recovery. | ||
* Copy cluster resources across cloud providers. NOTE: PersistenVolume objects are not supported. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
PersistenVolume
-> PersistentVolume
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure what the best wording is but we should clarify that cloud volume migrations are not supported. Technically, PV objects (i.e. the k8s objects are)
README.md
Outdated
> NOTE: Documentation may change between releases. See the [Changelog][20] for links to previous versions of this repository and its docs. | ||
> | ||
> To ensure that you are working off a specific release, `git checkout <VERSION_TAG>` where `<VERSION_TAG>` is the appropriate tag for the Ark version you wish to use (e.g. "v0.3.3"). You should `git checkout master` only if you're planning on [building the Ark image from scratch][7]. | ||
NOTE: Make sure to check out the appropriate version. TODO: fix up this text |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TODO
README.md
Outdated
|
||
* **Cross-cloud-provider migration** for Kubernetes API objects (cross-cloud-provider migration of persistent volume snapshots not yet supported) | ||
* Manage disaster recovery. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I find this kinda fuzzy, maybe something like "take periodic backups of your cluster and restore in case of loss" (i.e. highlight that this is the in-place backup/recovery use case)?
README.md
Outdated
* **Cross-cloud-provider migration** for Kubernetes API objects (cross-cloud-provider migration of persistent volume snapshots not yet supported) | ||
* Manage disaster recovery. | ||
* Copy cluster resources across cloud providers. NOTE: PersistenVolume objects are not supported. | ||
* Replicate your production environment for dev and testing enviornments. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
enviornments
-> environments
README.md
Outdated
1. *Configurable subsets of Kubernetes API objects* -- as tarballs stored in object storage | ||
2. *Disk snapshots of Persistent Volumes* -- via the cloud provider APIs | ||
* A server that runs on your cluster | ||
* A client with a CLI |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"client with a CLI" seems redundant
NAME BACKUP STATUS WARNINGS ERRORS CREATED SELECTOR | ||
nginx-backup-20170727200524 nginx-backup Completed 0 0 2017-07-27 20:05:24 +0000 UTC <none> | ||
``` | ||
1. Create a backup for any object that matches the `app=nginx` label selector: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
SGTM but not required for v0.7.0
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think it's a bad change, but I also agree that probably not as important for v0.7.0.
In this vein, it may be useful to provide a couple different examples in the docs later - using labels, using a namespace, excluding resources.
README.md
Outdated
|
||
1. The *ark client* makes a call to the Kubernetes API server, creating a `Backup` custom resource (which is stored in [etcd][22]). | ||
Your output should look like the following: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This may take a couple seconds to complete; do we want a note that it might show as InProgress at first?
README.md
Outdated
|
||
## Extensibility | ||
For more information, see [the debugging information][18]. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
broken link
README.md
Outdated
|
||
To learn more about Heptio Ark operations and their applications, see the [`/docs` directory][3]. | ||
[The documentation] provides detailed information about building from source, architecture, extending Ark, and more. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
broken link
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Correct link is now added, but it will be broken until we merge the gh-pages branch to upstream
docs/about.md
Outdated
Ark provides the following operations: | ||
|
||
* Backups | ||
* Schedules |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Scheduled Backups
?
@@ -5,167 +5,142 @@ | |||
[![Build Status][1]][2] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
On the sidebar, I don't see an explicit link to get back to README.md once you've navigated away (only clicking on the upper-left Heptio Ark gets there). Should/could we have a "Quickstart" link at the top of the nav to make this more obvious/easy
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I know :-(
I've attempted several solutions to this problem, unsuccessfully so far. I'll keep playing.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
docs/about.md
Outdated
|
||
Each operation is a custom resource, defined with a Kubernetes [Custom Resource Definition (CRD)][20] and stored in [etcd][22]. An additional custom resource, Config, specifies cloud provider settings. These resources are handled by [custom controllers][21] when their corresponding requests are submitted to the Kubernetes API server. | ||
|
||
Each controller watches its custom resource for API requests (Ark operations), performs validation, and handles most of the logic for interacting with the cloud provider API -- for example, managing object storage and persistent volumes. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
most of the logic
makes me wonder as a reader what it doesn't handle/why that's not explained
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ditto - let's remove the ambiguity. We handle all of it :)
docs/about.md
Outdated
|
||
### Restores | ||
|
||
The *restore* operation allows you to restore all of the objects and persistent volumes from a previously created Backup. Heptio Ark supports multiple namespace remapping--for example, in a single restore, objects in namespace "abc" can be recreated under namespace "def", and the ones in "123" under "456". |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe objects backed up from namespace "abc"
?
docs/cloud-common.md
Outdated
```bash | ||
kubectl delete namespaces nginx-example | ||
``` | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
wait for NS to be deleted?
docs/cloud-common.md
Outdated
|
||
```bash | ||
kubectl delete namespaces nginx-example | ||
kubectl delete pv $nginx_pv_name |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think this step to delete PVs is necessary (should be done automatically, although maybe there was a bug in the Azure provisioner?) but in any case this references a variable that we're not setting so won't work as-is.
docs/cloud-common.md
Outdated
ark restore create nginx-backup | ||
``` | ||
|
||
## Expired backup deletion |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This section and the following seem out of place on this page
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please make sure the .DS_Store files don't get added :)
docs/about.md
Outdated
|
||
Ark is ideal for the disaster recovery use case, as well as for snapshotting your application state, prior to performing system operations on your cluster (e.g. upgrades). | ||
|
||
Ark consists of a server and a client. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove this line?
docs/about.md
Outdated
|
||
Ark consists of a server and a client. | ||
|
||
## Server |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Call this "Features"?
docs/about.md
Outdated
|
||
Ark provides the following operations: | ||
|
||
* Backups |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One-time backups? Ad-hoc backups?
docs/about.md
Outdated
Ark provides the following operations: | ||
|
||
* Backups | ||
* Schedules |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Scheduled backups?
docs/about.md
Outdated
|
||
Each operation is a custom resource, defined with a Kubernetes [Custom Resource Definition (CRD)][20] and stored in [etcd][22]. An additional custom resource, Config, specifies cloud provider settings. These resources are handled by [custom controllers][21] when their corresponding requests are submitted to the Kubernetes API server. | ||
|
||
Each controller watches its custom resource for API requests (Ark operations), performs validation, and handles most of the logic for interacting with the cloud provider API -- for example, managing object storage and persistent volumes. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
validations
docs/gcp-config.md
Outdated
You can run Kubernetes on Google Cloud Platform in either of: | ||
|
||
* Kubernetes on Google Compute Engine virtual machines | ||
* With Google Kubernetes Engine |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove "With"?
docs/gcp-config.md
Outdated
If you run Google Kubernetes Engine (GKE), make sure that your current IAM user is a cluster-admin. This role is required to create RBAC objects. | ||
See [the GKE documentation][22] for more information. | ||
|
||
In the Ark root directory, run the following to first set up namespaces, RBAC, and other scaffolding. To run in a custom namespace, make sure that you have edited the YAML file to specify the namespace. See [Run in custom namespace][0]. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
files?
docs/gcp-config.md
Outdated
|
||
```bash | ||
kubectl create secret generic cloud-credentials \ | ||
--namespace heptio-ark \ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Adjust if needed
|
||
* (Optional) If you run the nginx example, in file `examples/nginx-app/with-pv.yaml`: | ||
|
||
* Replace `<YOUR_STORAGE_CLASS_NAME>` with `standard`. This is GCP's default `StorageClass` name. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same comment as above re storageclass
docs/gcp-config.md
Outdated
|
||
```bash | ||
kubectl apply -f examples/common/10-deployment.yaml | ||
kubectl apply -f examples/gcp/00-ark-config.yaml |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do config first
Probably not for today/tomorrow, but I feel like after Intro, we need Installation |
Is Installation basically what's under Cloud Provider atm? Trivial to change title in nav bar and corresponding topic titles, although a bit more content would probably also be needed ... |
Yeah, I'd say so. |
Just pushed interim changes; not all fixes are in yet. Still TODO: gcp.md, remove stray unwanted files |
18d9f4c
to
007ed05
Compare
Almost there; final cleanup in the morning. |
@ncdc fixes you requested should all be in now, along with a bunch of other stuff smallish and larger. Mostly fixed up links, added one file for better IA in built docs ( |
docs/build-from-scratch.md
Outdated
|
||
You can build your Ark image locally on the machine where you run your cluster, or you can push it to a private registry. This section covers both workflows. | ||
|
||
Set the `$REGISTRY` environment variable (used in the `Makefile`) if you want to push the Heptio Ark images to your own registry. This allows any node in your cluster to pull your locally built image. | ||
Set the `$REGISTRY` environment variable (used in the `Makefile`) to push the Heptio Ark images to your own registry. This allows any node in your cluster to pull your locally built image. | ||
|
||
`$PROJECT` and `$VERSION` environment variables are also specified in the `Makefile`, and can be similarly modified as desired. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
$PROJECT
is not currently valid any more. We hard code the image name to ark
but you can customize the image's tag by changing $VERSION
. We can revisit the customizability later, if needed.
docs/build-from-scratch.md
Outdated
All binaries are placed in `_output/bin/<GOOS>/<GOARCH>`, e.g. `_output/bin/darwin/amd64/ark`. | ||
By default, `make` builds an `ark` binary that runs on your host operating system and architecture. | ||
To build for another platform, run `make build-<GOOS>-<GOARCH`. | ||
For example, to build for the Mac, you runo `make build-darwin-amd64`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo: runo
README.md
Outdated
|
||
* **Cross-cloud-provider migration** for Kubernetes API objects (cross-cloud-provider migration of persistent volume snapshots not yet supported) | ||
* Take backups of your cluster and restore in case of loss. | ||
* Copy cluster resources across cloud providers. NOTE: Cloud volume migrations are not supported. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mind saying "not yet"?
README.md
Outdated
|
||
Note that this example *does not* include a demonstration of PV disk snapshots, because that feature requires integration with a cloud provider API. For snapshotting examples and instructions specific to AWS, GCP, and Azure, see [Cloud Provider Specifics][23]. | ||
* Access to a Kubernetes cluster, version 1.7 or later |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
FYI, you need at least 1.7.5 for ark backup delete
to work
README.md
Outdated
> NOTE: Documentation may change between releases. See the [Changelog][20] for links to previous versions of this repository and its docs. | ||
> | ||
> To ensure that you are working off a specific release, `git checkout <VERSION_TAG>` where `<VERSION_TAG>` is the appropriate tag for the Ark version you wish to use (e.g. "v0.3.3"). You should `git checkout master` only if you're planning on [building the Ark image from scratch][7]. | ||
NOTE: Make sure to check out the appropriate version. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it worth expanding just a little bit here, suggesting they check out the latest git tag, and commenting that master is under active development and things may be in flux?
## Architecture | ||
``` | ||
kubectl get deployments --namespace=nginx-example | ||
kubectl get services --namespace=nginx-example |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also kubectl get namespace/nginx-example
README.md
Outdated
|
||
4. Once the data has been aggregated, the `BackupController` makes a call to the object storage service (e.g. Amazon S3) to upload the backup file. | ||
After a successful restore, the `STATUS` column is `Completed`, and `WARNINGS` and `ERRORS` are 0. All objects in the `nginx-example` should be just as they were before you deleted them. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All objects in the nginx-example
namespace ...
README.md
Outdated
|
||
## Extensibility | ||
``` | ||
ark restore get <RESTORE_NAME> -o yaml |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This needs to be ark restore describe <RESTORE_NAME>
docs/about.md
Outdated
|
||
Note that cluster backups are not strictly atomic. If Kubernetes objects are being created or edited at the time of backup, they might not be included in the backup. The odds of capturing inconsistent information are low, but it is possible. | ||
|
||
On-demand backups are saved with the `<BACKUP NAME>` specified during creation. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not entirely sure what this is saying?
docs/about.md
Outdated
|
||
Here's what happens when you run `ark backup create test-backup`: | ||
|
||
1. The Ark client makes a call to the Kubernetes API server to create a `Backup` object from the custom resource. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please strike from the custom resource
. We could mention that it includes all the parameters you specified on the command line - namespaces to include/exclude, resources to include/exclude, label selector.
docs/build-from-scratch.md
Outdated
|
||
## 0. Prerequisites | ||
* Access to a Kubernetes cluster, version 1.7 or later |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same comment re 1.7.5+ for backup deletions to work
docs/cli-reference/README.md
Outdated
|
||
## Running the client | ||
|
||
While it is possible to build and run the `ark` executable yourself, it is recommended to use the containerized version. Use the alias described in the quickstart: | ||
While it is possible to build and run the `ark` executable yourself, we recommend that you run the containerized version. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please remove all text related to running the containerized version of the client. We only recommend they download a pre-built release, or if they desire, one they built from source.
README.md
Outdated
|
||
If there are errors or warnings, you can look at them in detail: | ||
|
||
``` | ||
ark restore get <RESTORE_NAME> -o yaml | ||
ark restore describe <RESTORE_NAME> -o yaml |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please remove -o yaml
0639982
to
00a48e1
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for this @Bradamant3! Most of my comments are about clarity rather than content.
Also it looks like the .DS_Store
file is included; it should probably be omitted.
README.md
Outdated
* **Cross-cloud-provider migration** for Kubernetes API objects (cross-cloud-provider migration of persistent volume snapshots not yet supported) | ||
* Take backups of your cluster and restore in case of loss. | ||
* Copy cluster resources across cloud providers. NOTE: Cloud volume migrations are not yet supported. | ||
* Replicate your production environment for dev and testing environments. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would probably spell out 'development' here.
README.md
Outdated
1. *Configurable subsets of Kubernetes API objects* -- as tarballs stored in object storage | ||
2. *Disk snapshots of Persistent Volumes* -- via the cloud provider APIs | ||
* A server that runs on your cluster | ||
* A CLI |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps "A command line client that runs on a local computer?" The server part mentions where it runs, but the line for the CLI could be a bit ambiguous for some.
README.md
Outdated
|
||
Note that this example *does not* include a demonstration of PV disk snapshots, because that feature requires integration with a cloud provider API. For snapshotting examples and instructions specific to AWS, GCP, and Azure, see [Cloud Provider Specifics][23]. | ||
* Access to a Kubernetes cluster, version 1.7 or later. Version 1.7.5 is required to run `ark backup delete`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should it be "Version 1.7.5 or higher is required to run ark backup delete
."? I assume it doesn't work on exclusively 1.7.5.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Correct
NAME BACKUP STATUS WARNINGS ERRORS CREATED SELECTOR | ||
nginx-backup-20170727200524 nginx-backup Completed 0 0 2017-07-27 20:05:24 +0000 UTC <none> | ||
``` | ||
1. Create a backup for any object that matches the `app=nginx` label selector: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think it's a bad change, but I also agree that probably not as important for v0.7.0.
In this vein, it may be useful to provide a couple different examples in the docs later - using labels, using a namespace, excluding resources.
README.md
Outdated
|
||
Ark has multiple mechanisms for extending the core functionality to meet your individual backup/restore needs: | ||
For more information, see [the debugging information][18]. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"Information" is repeated twice in the same sentence - maybe "see the debugging section" for the link text? Or "For more details, see the debugging information"
docs/about.md
Outdated
* Scheduled backups | ||
* Restores | ||
|
||
Each operation is a custom resource, defined with a Kubernetes [Custom Resource Definition (CRD)][20] and stored in [etcd][22]. An additional custom resource, Config, specifies cloud provider settings. These resources are handled by [custom controllers][21] when their corresponding requests are submitted to the Kubernetes API server. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think Config
is solely about cloud provider settings, though those are certainly included. Maybe something like "An additional custom resource, Config, specifies required information and customization options, such as cloud provider settings".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm fine if we leave this as-is, or if we make changes. Not a huge deal, especially once we get to backup targets.
|
||
1. Uploads a tarball of copied Kubernetes objects into cloud object storage. | ||
|
||
1. Calls the cloud provider API to make disk snapshots of persistent volumes, if specified. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it's been mentioned elsewhere, but things like Minio and Rook aren't necessarily cloud providers, though Ark could operate against them. Maybe refer to 'block storage API' instead of 'cloud provider' here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's hold off changing any language here until we do backup targets. This is fine for now.
docs/about.md
Outdated
* All PersistentVolume snapshots | ||
* All associated Restores | ||
|
||
## Cloud storage sync |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Similar to above about cloud providers, maybe "Object storage sync"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No need to change this now
docs/build-from-scratch.md
Outdated
|
||
## 0. Prerequisites | ||
* Access to a Kubernetes cluster, version 1.7 or later. Version 1.7.5 is required to run `ark backup delete`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same comment from elsewhere - "1.7.5 or higher", in case someone jumps straight to this doc.
docs/about.md
Outdated
|
||
Each controller watches its custom resource for API requests (Ark operations), performs validations, and handles the logic for interacting with the cloud provider API -- for example, managing object storage and persistent volumes. | ||
Each controller watches its custom resource for API requests (Ark operations), performs validations, and handles the logic for interacting with the block storage API -- for example, managing object storage and persistent volumes. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please undo this change - keep it as cloud provider API
docs/about.md
Outdated
|
||
### On-demand backups | ||
|
||
The **backup** operation: | ||
|
||
1. Uploads a tarball of copied Kubernetes objects into cloud object storage. | ||
|
||
1. Calls the cloud provider API to make disk snapshots of persistent volumes, if specified. | ||
1. Calls the block storage API to make disk snapshots of persistent volumes, if specified. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Undo
docs/about.md
Outdated
@@ -70,11 +70,11 @@ When you create a backup, you can specify a TTL by adding the flag `--ttl <DURAT | |||
* All PersistentVolume snapshots | |||
* All associated Restores | |||
|
|||
## Cloud storage sync | |||
## Object storage sync |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This change is probably ok
3f6fb09
to
7d646a8
Compare
Signed-off-by: JENNIFER RONDEAU <jrondeau@heptio.com>
7d646a8
to
3b8e32f
Compare
* OADP-3654: fix CVE CVE-2024-24786 * update go.sum
Fixes #290
@ncdc
@skriss
@nrb