Skip to content

Commit

Permalink
feat: v1 api docs and example update (#240)
Browse files Browse the repository at this point in the history
* feat: v1 api docs and example update

* fix: docker version failing in circle

* feat: use default image for setup_remote_docker
  • Loading branch information
Azahorscak authored Jan 2, 2025
1 parent 520cda0 commit efe54fd
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 10 deletions.
3 changes: 1 addition & 2 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,7 @@ jobs:
- image: goreleaser/goreleaser:v1.11.4
steps:
- checkout
- setup_remote_docker:
version: 20.10.11
- setup_remote_docker
- *install_vault
- rok8s/get_vault_env:
vault_path: repo/global/env
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ The `schedule` parameter tells Gemini how often to create snapshots, and how man

For example, the following schedule tells Gemini to create a snapshot every day, keeping two weeks worth of history:
```yaml
apiVersion: gemini.fairwinds.com/v1beta1
apiVersion: gemini.fairwinds.com/v1
kind: SnapshotGroup
metadata:
name: test-volume
Expand All @@ -84,7 +84,7 @@ For a more complex example, Gemini can create new snapshots every 10 minutes,
always keep the last 3 snapshots, and preserve historical hourly, daily, monthly, and yearly snapshots.
```yaml
apiVersion: gemini.fairwinds.com/v1beta1
apiVersion: gemini.fairwinds.com/v1
kind: SnapshotGroup
metadata:
name: test-volume
Expand Down Expand Up @@ -123,7 +123,7 @@ E.g. right after a new snapshot is created, you'll see snapshots for
The following example schedules snapshots every 10 minutes for a pre-existing PVC named `postgres`.

```yaml
apiVersion: gemini.fairwinds.com/v1beta1
apiVersion: gemini.fairwinds.com/v1
kind: SnapshotGroup
metadata:
name: test-volume
Expand All @@ -139,7 +139,7 @@ spec:
You can also specify an entire PVC spec inside the SnapshotGroup if you'd like Gemini to create
the PVC for you.
```yaml
apiVersion: gemini.fairwinds.com/v1beta1
apiVersion: gemini.fairwinds.com/v1
kind: SnapshotGroup
metadata:
name: test-volume
Expand All @@ -164,7 +164,7 @@ most notably the name of the [snapshot class](https://kubernetes.io/docs/concept
you want to use.

```yaml
apiVersion: gemini.fairwinds.com/v1beta1
apiVersion: gemini.fairwinds.com/v1
kind: SnapshotGroup
metadata:
name: test-volume
Expand All @@ -176,7 +176,7 @@ spec:
keep: 3
template:
spec:
volumeSnapshotClassName: test-snapshot-class
volumeSnapshotClassName: test-snapshot-class
```

### Restore
Expand Down
2 changes: 1 addition & 1 deletion examples/bash/04-create-snapshotgroup.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
apiVersion: gemini.fairwinds.com/v1beta1
apiVersion: gemini.fairwinds.com/v1
kind: SnapshotGroup
metadata:
name: ebs-gemini-testing
Expand Down
2 changes: 1 addition & 1 deletion examples/bash/course.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ charts:
hooks:
pre_install:
# install the AWS EBS CSI driver, the snapshotter, its controller, and associated CRDs first
- kubectl apply -k "github.com/kubernetes-sigs/aws-ebs-csi-driver/deploy/kubernetes/overlays/alpha/?ref=master"
- kubectl apply -k "github.com/kubernetes-sigs/aws-ebs-csi-driver/deploy/kubernetes/overlays/stable/?ref=master"
- kubectl apply -f https://raw.githubusercontent.com/kubernetes-csi/external-snapshotter/master/client/config/crd/snapshot.storage.k8s.io_volumesnapshotclasses.yaml
- kubectl apply -f https://raw.githubusercontent.com/kubernetes-csi/external-snapshotter/master/client/config/crd/snapshot.storage.k8s.io_volumesnapshots.yaml
- kubectl apply -f https://raw.githubusercontent.com/kubernetes-csi/external-snapshotter/master/client/config/crd/snapshot.storage.k8s.io_volumesnapshotcontents.yaml

0 comments on commit efe54fd

Please sign in to comment.