-
Notifications
You must be signed in to change notification settings - Fork 161
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
And break up 'Getting Started'. This layout is inspired by Tilt's docs, which are often mentioned as Good.
- Loading branch information
1 parent
4a2745a
commit ff81e28
Showing
14 changed files
with
234 additions
and
197 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,142 @@ | ||
| --- | ||
| title: 2. Deploy an Application | ||
| hide_title: true | ||
| --- | ||
|
|
||
| # Part 2: Deploy an Application | ||
|
|
||
| Now that you have a feel for how to navigate the dashboard, let's deploy a new | ||
| application to explore further. In this section we will use the [podinfo](https://github.com/stefanprodan/podinfo) sample web application. | ||
|
|
||
| ## Deploying podinfo | ||
|
|
||
| 1. Clone or navigate back to your git repository where you have bootstrapped Flux, for example: | ||
|
|
||
| ``` | ||
| git clone https://github.com/$GITHUB_USER/fleet-infra | ||
| cd fleet-infra | ||
| ``` | ||
|
|
||
| 1. Create a `GitRepository` Source for podinfo | ||
|
|
||
| ``` | ||
| flux create source git podinfo \ | ||
| --url=https://github.com/stefanprodan/podinfo \ | ||
| --branch=master \ | ||
| --interval=30s \ | ||
| --export > ./clusters/my-cluster/podinfo-source.yaml | ||
| ``` | ||
|
|
||
| 1. Commit and push the `podinfo-source` to the `fleet-infra` repository | ||
|
|
||
| ``` | ||
| git add -A && git commit -m "Add podinfo source" | ||
| git push | ||
| ``` | ||
|
|
||
| 1. Create a `kustomization` to build and apply the podinfo manifest | ||
|
|
||
| ``` | ||
| flux create kustomization podinfo \ | ||
| --target-namespace=flux-system \ | ||
| --source=podinfo \ | ||
| --path="./kustomize" \ | ||
| --prune=true \ | ||
| --interval=5m \ | ||
| --export > ./clusters/my-cluster/podinfo-kustomization.yaml | ||
| ``` | ||
|
|
||
| 1. Commit and push the `podinfo-kustomization` to the `fleet-infra` repository | ||
|
|
||
| ``` | ||
| git add -A && git commit -m "Add podinfo kustomization" | ||
| git push | ||
| ``` | ||
|
|
||
| ## View the application in Weave GitOps | ||
|
|
||
| Flux will detect the updated `fleet-infra` and add podinfo. If we navigate back to the [dashboard](http://localhost:9001/) you should see the podinfo application appear. | ||
|
|
||
|  | ||
|
|
||
| Click on podinfo and you will see details about the deployment, including that there are 2 pods available. | ||
|
|
||
|  | ||
|
|
||
| :::info | ||
| Podinfo will come with the HorizontalPodAutoscaler, which uses the `metrics-server`. | ||
| For the purposes of this tutorial, we don't need the `metrics-server`, but it will mean | ||
| that the HorizontalPodAutoscaler will report as `Not ready` in your Dashboard. | ||
|
|
||
| To remove this warning, install the [`metrics-server`](https://github.com/kubernetes-sigs/metrics-server) | ||
| (if you are using a `kind` cluster you may need to do more to get this working), | ||
| but you can ingore the warning if you prefer. | ||
| ::: | ||
|
|
||
| ## Customize podinfo | ||
|
|
||
| To customize a deployment from a repository you don’t control, you can use Flux in-line patches. The following example shows how to use in-line patches to change the podinfo deployment. | ||
|
|
||
| 1. Add the `patches` section as shown below to the field spec of your `podinfo-kustomization.yaml` file so it looks like this: | ||
|
|
||
| ```yaml title="./clusters/my-cluster/podinfo-kustomization.yaml" | ||
| --- | ||
| apiVersion: kustomize.toolkit.fluxcd.io/v1beta2 | ||
| kind: Kustomization | ||
| metadata: | ||
| name: podinfo | ||
| namespace: flux-system | ||
| spec: | ||
| interval: 60m0s | ||
| path: ./kustomize | ||
| prune: true | ||
| sourceRef: | ||
| kind: GitRepository | ||
| name: podinfo | ||
| targetNamespace: flux-system | ||
| // highlight-start | ||
| patches: | ||
| - patch: |- | ||
| apiVersion: autoscaling/v2beta2 | ||
| kind: HorizontalPodAutoscaler | ||
| metadata: | ||
| name: podinfo | ||
| spec: | ||
| minReplicas: 3 | ||
| target: | ||
| name: podinfo | ||
| kind: HorizontalPodAutoscaler | ||
| // highlight-end | ||
| ``` | ||
|
|
||
| 1. Commit and push the `podinfo-kustomization.yaml` changes: | ||
|
|
||
| ``` | ||
| git add -A && git commit -m "Increase podinfo minimum replicas" | ||
| git push | ||
| ``` | ||
|
|
||
| 3. Navigate back to the dashboard and you will now see a newly created pod | ||
|
|
||
|  | ||
|
|
||
|
|
||
| ## Suspend updates | ||
|
|
||
| Suspending updates to a kustomization allows you to directly edit objects applied from a kustomization, without your changes being reverted by the state in Git. | ||
|
|
||
| To suspend updates for a kustomization, from the details page, click on the suspend button at the top, and you should see it be suspended: | ||
|
|
||
|  | ||
|
|
||
| This shows in the applications view with a yellow warning status indicating it is now suspended | ||
|
|
||
|  | ||
|
|
||
| To resume updates, go back to the details page, click the resume button, and after a few seconds reconsolidation will continue. | ||
|
|
||
| ## Complete! | ||
|
|
||
| Congratulations 🎉🎉🎉 | ||
|
|
||
| You've now completed the getting started guide. We would welcome any and all [feedback](/feedback-and-telemetry) on your experience. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| --- | ||
| title: Getting Started | ||
| hide_title: true | ||
| --- | ||
|
|
||
| # Getting Started with Weave GitOps | ||
|
|
||
| This hands-on guide will introduce you to the basics of the GitOps Dashboard web UI, to help you understand the state of your system, before deploying a new application to your cluster. It is adapted from this guide - [Flux - Getting Started](https://fluxcd.io/docs/get-started/). | ||
|
|
||
| If you haven't already, be sure to check out our [introduction](../intro.mdx) to Weave GitOps and our [installation docs](../installation/index.mdx). | ||
|
|
||
| ## TL;DR: Highlights | ||
|
|
||
| - **Applications view** - allows you to quickly understand the state of your deployments across a cluster at a glance. It shows summary information from `kustomization` and `helmrelease` objects. | ||
| - **Sources view** - shows the status of resources which are synchronizing content from where you have declared the desired state of your system, for example Git repositories. This shows summary information from `gitrepository`, `helmrepository` and `bucket` objects. | ||
| - **Flux Runtime view** - provides status on the GitOps engine continuously reconciling your desired and live state. It shows your installed GitOps Toolkit Controllers and their version. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.