Skip to content

Commit

Permalink
Update gitops-data example docs (#290)
Browse files Browse the repository at this point in the history
  • Loading branch information
RothAndrew authored and jeff-mccoy committed Feb 8, 2022
1 parent a378468 commit 4d88268
Showing 1 changed file with 24 additions and 10 deletions.
34 changes: 24 additions & 10 deletions examples/gitops-data/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ choice.

## Demonstrated Features

### Docker Image Deployment
### Docker Image Push

This example demonstrates using component `images` to deploy container images
to a docker container image registry. Images provided to the `images` tag are
This example demonstrates using component `images` to push container images
to an image registry. Images provided to the `images` tag are
uploaded to a Zarf hosted docker registry, which can be later used by
Kubernetes manifests, or manually used as shown in this guide.

Expand Down Expand Up @@ -67,17 +67,31 @@ container images to the Docker registry.
zarf package deploy zarf-package-gitops-service-data.tar.zst
```

> _**Important**_
>
> It's possible to try a package deploy _before the Zarf cluster is ready to receive it_. If you see an error like `"https://<cluster ip>/v2/": dial tcp ,<cluster ip>:443: connect: connection refused;` then it's very likely that you've beat the Zarf startup routines.
>
> The fix is simple: just wait for the cluster to finish starting & try again.
## Applying the Kustomization

Once the package has been deployed, the Kustomization can be applied from the
Gitea repository using the below command.

```sh
kubectl apply -k https://zarf-git-user:$(./zarf tools get-admin-password)@localhost/zarf-git-user/mirror__github.com__stefanprodan__podinfo//kustomize
# Run 'zarf connect' and send it to the background
zarf connect git&

# Apply the kustomization
kubectl apply -k http://zarf-git-user:$(zarf tools get-admin-password)@localhost:<WhicheverPortGotUsed>/zarf-git-user/mirror__github.com__stefanprodan__podinfo//kustomize

# Inspect
zarf tools k9s

# Bring the connection back to the foreground
fg

# Kill the connection with Ctrl-C
```

## Clean Up

Clean up simply by just deleting the whole cluster

```sh
kind delete cluster
```

0 comments on commit 4d88268

Please sign in to comment.