Skip to content

Commit 2ce030c

Browse files
author
JENNIFER RONDEAU
committed
more tweaks to content per review comments
Signed-off-by: JENNIFER RONDEAU <[email protected]>
1 parent 9167103 commit 2ce030c

File tree

5 files changed

+20
-14
lines changed

5 files changed

+20
-14
lines changed

docs/get-started.md

+9-5
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The following example sets up the Ark server and client, then backs up and resto
44

55
For simplicity, the example uses Minio, an S3-compatible storage service that runs locally on your cluster.
66

7-
**NOTE** The example lets you explore basic Ark functionality. In the real world, however, you would back your cluster up to external storage.
7+
**NOTE** The example lets you explore basic Ark functionality. Configuring Minio for production is out of scope.
88

99
See [Set up Ark on your platform][3] for how to configure Ark for a production environment.
1010

@@ -26,7 +26,7 @@ NOTE: Make sure to check out the appropriate version. We recommend that you chec
2626

2727
### Set up server
2828

29-
These instructions assume that you are running Minio inside your cluster. They should be used for a test environment or to explore Ark only. Service of type `NodePort` is not recommended for production.
29+
These instructions assume that you are running Minio inside your cluster. They should be used for a test environment or to explore Ark only.
3030

3131
1. In `examples/minio/00-minio-deployment.yaml`, change the value of Service `spec.type` from `ClusterIP` to `NodePort`.
3232

@@ -55,14 +55,18 @@ These instructions assume that you are running Minio inside your cluster. They s
5555
kubectl -n heptio-ark get svc/minio -o jsonpath='{.spec.ports[0].nodePort}'
5656
```
5757
58-
1. **For Service type `NodePort` only** In `examples/minio/05-ark-backupstoragelocation.yaml`, replace NODE_URL_OR_IP:NODE_PORT with the value of the Minio URL.
58+
1. Do one of the following:
5959
60-
1. If you have set up Ingress or a load balancer, SOMETHINGSOMETHING PR 1006
60+
- **For Service type `NodePort` only** In `examples/minio/05-ark-backupstoragelocation.yaml`, replace NODE_URL_OR_IP:NODE_PORT with the value of the Minio URL.
61+
62+
- If you have set up Ingress or a load balancer, leave the Service `spec.type` as `ClusterIP` and leave the default value of `s3Url` in `examples/minio/05-ark-backupstoragelocation.yaml`.
63+
64+
- If you set up a download URL, for example for logs, instead of a value for `s3Url` you can provide a value for `publicUrl` in `examples/minio/05-ark-backupstoragelocation.yaml`.
6165
6266
1. Start the server:
6367
6468
```shell
65-
kubectl apply -f examples/minio/20-ark-deployment.yaml examples/minio/30-restic-daemonset.yaml
69+
kubectl apply -f examples/minio/20-ark-deployment.yaml -f examples/minio/30-restic-daemonset.yaml
6670
```
6771
6872
1. Deploy the example nginx application:

docs/rbac.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Run Ark more securely with restrictive RBAC settings
22

3-
By default Ark runs with an RBAC policy of ClusterRole `cluster-admin`. This is to make sure that Ark can back up or restore anything in your cluster. But `cluster-admin` access is wide open -- it gives Ark components access to everything in your cluster. Depending on your environment and your security needs, you should consider whether to configure more restrictive access.
3+
By default Ark runs with an RBAC policy of ClusterRole `cluster-admin`. This is to make sure that Ark can back up or restore anything in your cluster. But `cluster-admin` access is wide open -- it gives Ark components access to everything in your cluster. Depending on your environment and your security needs, you should consider whether to configure additional RBAC policies with more restrictive access.
44

55
**Note:** Roles and RoleBindings are associated with a single namespaces, not with an entire cluster. PersistentVolume backups are associated only with an entire cluster. This means that any backups or restores that use a restrictive Role and RoleBinding pair can manage only the resources that belong to the namespace. You do not need a wide open RBAC policy to manage PersistentVolumes, however. You can configure a ClusterRole and ClusterRoleBinding that allow backups and restores only of PersistentVolumes, not of all objects in the cluster.
66

@@ -11,7 +11,7 @@ For more information about RBAC and access control generally in Kubernetes, see
1111
Here's a sample Role and RoleBinding pair.
1212

1313
```yaml
14-
apiVersion: rbac.authorization.k8s.io/v1beta1
14+
apiVersion: rbac.authorization.k8s.io/v1
1515
kind: Role
1616
metadata:
1717
namespace: YOUR_NAMESPACE_HERE
@@ -28,13 +28,13 @@ rules:
2828
```
2929
3030
```yaml
31-
apiVersion: rbac.authorization.k8s.io/v1beta1
31+
apiVersion: rbac.authorization.k8s.io/v1
3232
kind: RoleBinding
3333
metadata:
3434
name: ROLEBINDING_NAME_HERE
3535
subjects:
36-
- kind: User
37-
name: YOUR_USER_HERE
36+
- kind: ServiceAccount
37+
name: YOUR_SERVICEACCOUNT_HERE
3838
roleRef:
3939
kind: Role
4040
name: ROLE_NAME_HERE

docs/versions.md

+2
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ Breaking changes are documented in the release notes and in the documentation.
1919
Not all Ark versions support all versions of Kubernetes. You should be aware of the following known limitations:
2020

2121
- Ark version 0.9.0 requires Kubernetes version 1.8 or later. In version 0.9.1, Ark was updated to support earlier versions.
22+
- Restic support requires Kubernetes version 1.10 or later, or an earlier version with the mount propagation feature enabled. See [Restic Integration][3].
2223

2324
[1]: https://github.com/heptio/ark/releases
2425
[2]: upgrading-to-v0.10.md
26+
[3]: restic.md

examples/minio/00-minio-deployment.yaml

+3-3
Original file line numberDiff line numberDiff line change
@@ -63,9 +63,9 @@ metadata:
6363
labels:
6464
component: minio
6565
spec:
66-
# ClusterIP is recommended for production environments
67-
# change to NodePort if needed per documentation,
68-
# but only you run Minio in a test/trial environment, for example with minikube
66+
# ClusterIP is recommended for production environments.
67+
# Change to NodePort if needed per documentation,
68+
# but only if you run Minio in a test/trial environment, for example with Minikube.
6969
type: ClusterIP
7070
ports:
7171
- port: 9000

examples/minio/05-ark-backupstoragelocation.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ spec:
2626
region: minio
2727
s3ForcePathStyle: "true"
2828
s3Url: http://minio.heptio-ark.svc:9000
29-
# OR get minio URL per documentation (comment out previous line)
29+
# OR get minio URL (including http/s) per documentation (comment out previous line)
3030
# s3Url: NODE_URL_OR_IP:NODE_PORT
3131

3232

0 commit comments

Comments
 (0)