Skip to content

Commit 1664848

Browse files
author
JENNIFER RONDEAU
committed
more edits to backup config instructions
Signed-off-by: JENNIFER RONDEAU <[email protected]>
1 parent 5820a17 commit 1664848

File tree

1 file changed

+28
-6
lines changed

1 file changed

+28
-6
lines changed

docs/get-started.md

+28-6
Original file line numberDiff line numberDiff line change
@@ -55,23 +55,45 @@ When you run commands to get logs or describe a backup, the Ark server generates
5555
- Change the Minio Service type from `ClusterIP` to `NodePort`.
5656
- Set up Ingress for your cluster, keeping Minio Service type `ClusterIP`.
5757

58-
In Ark 0.10, you also specify the value of a new `publicUrl` field for the pre-signed URL in your backup storage config.
58+
In Ark 0.10, you can also specify the value of a new `publicUrl` field for the pre-signed URL in your backup storage config.
5959

6060
#### Expose Minio with Service of type NodePort
6161

6262
The Minio deployment by default specifies a Service of type `ClusterIP`. You can change this to `NodePort` to easily expose a cluster service externally if you can reach the node from your Ark client.
6363

64-
- In `examples/minio/00-minio-deployment.yaml`, change the value of Service `spec.type` from `ClusterIP` to `NodePort`.
64+
You must also get the Minio URL, which you can then specify as the value of either the `s3Url` or the new `publicUrl` field in your backup storage config.
65+
66+
1. In `examples/minio/00-minio-deployment.yaml`, change the value of Service `spec.type` from `ClusterIP` to `NodePort`.
67+
68+
1. Get the Minio URL:
69+
70+
- if you're running Minikube:
71+
72+
```shell
73+
minikube service minio --namespace=heptio-ark --url
74+
```
75+
76+
- in any other environment:
77+
78+
1. Get the value of an external IP address or DNS name of any node in your cluster. You must be able to reach this address from the Ark client.
79+
80+
1. Append the value of the NodePort to get a complete URL. You can get this value by running:
81+
82+
```shell
83+
kubectl -n heptio-ark get svc/minio -o jsonpath='{.spec.ports[0].nodePort}'
84+
```
85+
86+
1. In `examples/minio/05-ark-backupstoragelocation.yaml`, provide this Minio URL as the value of either the `s3Url` or the `publicUrl` field. You must include the `http://` or `https://` prefix.
6587
6688
#### Work with Ingress
6789
68-
Configuring Ingress for your cluster is out of scope for the Ark documentation. If you have already set up Ingress, however, it makes sense to continue with it while you run the example Ark configuration with Minio.
90+
Configuring Ingress for your cluster is out of scope for the Ark documentation. If you have already set up Ingress, however, it makes sense to continue with it while you run the example Ark configuration with Minio.
6991
70-
#### Specify `publicUrl` for external access
92+
In this case:
7193
72-
Whether you expose Minio with Service of type `NodePort` or with Ingress, if you want to get logs or run other commands that require external access, in Ark 0.10 you provide the download URL to avoid errors.
94+
1. Keep the Service type as `ClusterIP`.
7395
74-
- In `examples/minio/05-ark-backupstoragelocation.yaml`, specify the value of the `publicUrl` field TO WHAT?
96+
1. In In `examples/minio/05-ark-backupstoragelocation.yaml`, provide the URL and port of your Ingress as the value of the `publicUrl` field
7597
7698
### Install client
7799

0 commit comments

Comments
 (0)