Skip to content

Commit 4865ad6

Browse files
authored
minikube and macos documentation (#77)
Signed-off-by: Jordan Dubrick <[email protected]>
1 parent f55ab8e commit 4865ad6

File tree

2 files changed

+15
-0
lines changed

2 files changed

+15
-0
lines changed

Diff for: DEVFILE_REGISTRY.md

+13
Original file line numberDiff line numberDiff line change
@@ -206,3 +206,16 @@ spec:
206206
ingressDomain: $INGRESS_DOMAIN
207207
EOF
208208
```
209+
## Accessing the Deployed Registry
210+
211+
After the devfile registry is deployed to the cluster you can access it via the `ingressDomain` you set. If you deployed to Minikube and are currently working on MacOS and you find trying to connect via the `ingressDomain` is timing out, please see [MacOS Troubleshooting](#macos-troubleshooting).
212+
213+
## MacOS Troubleshooting
214+
215+
Currently there is an issue with Minikube and MacOS where you cannot connect to a cluster using an ingress service. If this occurs you can follow these steps to access your cluster:
216+
1. Edit `/etc/hosts` to map `127.0.0.1` to your `ingressDomain`. Typically this is set to your Minikube ip, however, MacOS needs localhost.
217+
2. Open a new terminal and run `minikube tunnel`. This opens a route using the cluster's ip address.
218+
3. In a different terminal than the one you ran `minikube tunnel` in, run `minikube service devfile-registry --url -n <namespace of the registry>`. This will output 3 ips including ports.
219+
4. The ip addresses and ports listed in step 4 are used to access your registry. The ports are the most important here as you can access the registry with `127.0.0.1:<port>` or `<ingressDomain>:<port>`
220+
221+
From testing, majority of the time the first `<ip>:<port>` directs you to `/viewer` so you can view the registry in your browser. If this differs you will need to try them all.

Diff for: README.md

+2
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,9 @@ make install && make deploy
6868

6969
The operator will be installed under the `registry-operator-system` namespace. However, devfile registries can be deployed in any namespace.
7070

71+
## Deploying registry to a cluster
7172

73+
After the operator has been installed to a cluster you can deploy a devfile registry by following [these instructions](DEVFILE_REGISTRY.md).
7274
## Development
7375

7476
The repository contains a Makefile; building and deploying can be configured via the environment variables

0 commit comments

Comments
 (0)