-
Notifications
You must be signed in to change notification settings - Fork 126
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: roi.kramer <[email protected]>
- Loading branch information
1 parent
e14321e
commit 9f3b0cc
Showing
6 changed files
with
276 additions
and
50 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,32 @@ | ||
| # Advanced Installation Options | ||
|
|
||
|
|
||
| ### Bootstrap under a specific path | ||
| If you want the autopilot managed folder structure to reside under some sub-folder in your repository, you can also export the following env variable: | ||
| ``` | ||
| export GIT_REPO=https://github.com/owner/name.git/some/relative/path | ||
| ``` | ||
| You should see the `bootstrap/` directory under `/some/relative/path/bootstrap`. | ||
|
|
||
| ### Bootstrap on a specific branch | ||
| If you want to use a specific branch for your GitOps repository operations, you can use the `ref` query parameter: | ||
| ``` | ||
| export GIT_REPO=https://github.com/owner/name?ref=gitops_branch | ||
| ``` | ||
|
|
||
| !!! note | ||
| When running commands that commit or write to the repository, the value of `ref` can only be a branch. | ||
|
|
||
|
|
||
| !!! tip | ||
| When running commands that commit or write to the repository you may also specify the `-b`, this would create the branch specified in `ref` if it doesn't exist. | ||
|
|
||
| Note that when doing so the new branch would be created from the default branch. | ||
|
|
||
|
|
||
|
|
||
| ### High Availability | ||
| You can bootstrap Argo CD in high-availability mode using the [App Specifier](App-Specifier/): | ||
| ``` | ||
| argocd-autopilot repo bootstrap --app https://github.com/argoproj-labs/argocd-autopilot/manifests/ha | ||
| ``` |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| # Git Providers | ||
|
|
||
| Autopilot fully automates the installation process and bootstrapping of Argo CD, it can even create and initialize a git repository if required, but to do so it needs to have access to your git provider. | ||
|
|
||
| The following git providers are currently supported: | ||
|
|
||
| * Github | ||
| * Gitlab | ||
| * Bitbucket Server (on-prem only) | ||
| * Azure DevOps | ||
| * Gitea |
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,159 @@ | ||
| One of the benefits you get from using Argo-CD Autopilot is the bootstrap installation of Argo-CD. This means that Argo-CD will manage and reconcile itself based on the desired in your installation repository. | ||
|
|
||
| The state of Argo-CD is managed by the `argo-cd` application that is deployed by the `autopilot-bootstrap` application. The application is a kustomize type application and generates its Argo-CD manifests from `bootstrap/argo-cd/kustomization.yaml`. | ||
|
|
||
|  | ||
| <sub>One of the applications you get after the initial bootstrap is the `argo-cd` application</sub> | ||
|
|
||
| To modify your Argo-CD installation you would need to use the GitOps approach. This means you cannot modify Argo-CD resources directly in the cluster, instead you should use [kustomize patches](https://kubectl.docs.kubernetes.io/references/kustomize/kustomization/patches/) to modify the resources generated from `bootstrap/argo-cd/kustomization.yaml`. | ||
|
|
||
| Here are a few examples of common Argo-CD modifications: | ||
|
|
||
| ### Specifying Requests and Limits | ||
| The following shows the kustomization file in `bootstrap/argo-cd/kustomization.yaml` with patches which sets the `requests` and `limits` for `argocd-repo-server` and `argocd-application-controller`. Note that some parts of the file were omitted in this example. | ||
|
|
||
| You can use the same method to set `requests` and `limits` for any other Argo-CD component. | ||
|
|
||
| ```yaml | ||
| apiVersion: kustomize.config.k8s.io/v1beta1 | ||
| kind: Kustomization | ||
| namespace: argocd | ||
| resources: | ||
| - github.com/argoproj-labs/argocd-autopilot/manifests/base?ref=v0.4.10 | ||
|
|
||
| # Added these patches | ||
| patches: | ||
| - target: | ||
| group: apps | ||
| version: v1 | ||
| kind: Deployment | ||
| name: argocd-repo-server | ||
| patch: |- | ||
| - op: add | ||
| path: /spec/template/spec/containers/0/resources | ||
| value: | ||
| requests: | ||
| memory: 4Gi | ||
| limits: | ||
| ephemeral-storage: 4Gi | ||
| memory: 4Gi | ||
| - target: | ||
| group: apps | ||
| version: v1 | ||
| kind: StatefulSet | ||
| name: argocd-application-controller | ||
| patch: |- | ||
| - op: add | ||
| path: /spec/template/spec/containers/0/resources | ||
| value: | ||
| requests: | ||
| memory: 4Gi | ||
| limits: | ||
| memory: 4Gi | ||
| # rest omitted for brevity... | ||
| ``` | ||
|
|
||
| ### Disable Admin Account and Add Another Account | ||
| In the following example we use the `configMapGenerator` feature of kustomize to modify the `argocd-cm` configmap to disable the admin account, which comes with Argo-CD by default, and add another account instead. | ||
|
|
||
| Note that you would need to [activate](https://argo-cd.readthedocs.io/en/stable/operator-manual/user-management/#manage-users) the `alice` account using the `admin` account *before* disabling the `admin` account. | ||
| ```yaml | ||
| apiVersion: kustomize.config.k8s.io/v1beta1 | ||
| kind: Kustomization | ||
| namespace: argocd | ||
| resources: | ||
| - github.com/argoproj-labs/argocd-autopilot/manifests/base?ref=v0.4.10 | ||
|
|
||
| configMapGenerator: | ||
| - behavior: merge | ||
| name: argocd-cm | ||
| literals: | ||
| # some keys omitted for brevity... | ||
| - admin.enabled=false | ||
| - accounts.alice=apiKey, login | ||
| ``` | ||
| ### Ingress Configuration | ||
| The following example shows how you would configure ingress using AWS Application Load Balancer. You can easily use this example to configure ingress using other ingress controllers and you can refer to the [official Argo-CD documetation](https://argo-cd.readthedocs.io/en/stable/operator-manual/ingress) for additional information. | ||
| Create the `argogrpc` service: | ||
|
|
||
| ```yaml | ||
| # /bootstrap/argo-cd/argogrpc.service.yaml | ||
| apiVersion: v1 | ||
| kind: Service | ||
| metadata: | ||
| annotations: | ||
| alb.ingress.kubernetes.io/backend-protocol-version: HTTP2 #This tells AWS to send traffic from the ALB using HTTP2. Can use GRPC as well if you want to leverage GRPC specific features | ||
| labels: | ||
| app: argogrpc | ||
| name: argogrpc | ||
| spec: | ||
| ports: | ||
| - name: "443" | ||
| port: 443 | ||
| protocol: TCP | ||
| targetPort: 8080 | ||
| selector: | ||
| app.kubernetes.io/name: argocd-server | ||
| sessionAffinity: None | ||
| type: NodePort | ||
| ``` | ||
|
|
||
| Create the ingress resource: | ||
|
|
||
| ```yaml | ||
| # /bootstrap/argo-cd/ingress.yaml | ||
| apiVersion: networking.k8s.io/v1 | ||
| kind: Ingress | ||
| metadata: | ||
| annotations: | ||
| alb.ingress.kubernetes.io/backend-protocol: HTTPS | ||
| alb.ingress.kubernetes.io/conditions.argogrpc: | | ||
| [{"field":"http-header","httpHeaderConfig":{"httpHeaderName": "Content-Type", "values":["application/grpc"]}}] | ||
| alb.ingress.kubernetes.io/listen-ports: '[{"HTTPS":443}]' | ||
| alb.ingress.kubernetes.io/target-type: 'ip' | ||
| alb.ingress.kubernetes.io/scheme: internet-facing | ||
| name: argocd | ||
| spec: | ||
| rules: | ||
| - host: argocd.argoproj.io | ||
| http: | ||
| paths: | ||
| - path: / | ||
| backend: | ||
| service: | ||
| name: argogrpc | ||
| port: | ||
| number: 443 | ||
| pathType: Prefix | ||
| - path: / | ||
| backend: | ||
| service: | ||
| name: argocd-server | ||
| port: | ||
| number: 443 | ||
| pathType: Prefix | ||
| tls: | ||
| - hosts: | ||
| - argocd.argoproj.io | ||
| ``` | ||
|
|
||
| Add the new resources to the kustomization file: | ||
|
|
||
| ```yaml | ||
| # /bootstrap/argo-cd/kustomization.yaml | ||
| apiVersion: kustomize.config.k8s.io/v1beta1 | ||
| kind: Kustomization | ||
| namespace: argocd | ||
| resources: | ||
| - github.com/argoproj-labs/argocd-autopilot/manifests/base?ref=v0.4.10 | ||
| # Added new resources: | ||
| - ./ingress.yaml | ||
| - ./argogrpc.service.yaml | ||
| # rest omitted for brevity... | ||
| ``` | ||
|
|
||
| If ALB is correctly configured on your cluster, the `argo-cd` application would successfully reconcile after the new ingress resource will be updated with its external address. Then you should be able to reach your Argo-CD through the external address. |
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,29 @@ | ||
| #### Recovering From an Existing Repository | ||
| If, for any reason, something happens to your argo-cd installation, you can recover from an existing repository using the `--recover` flag. | ||
|
|
||
| This should re-apply Argo-CD to the cluster, then create the `autopilot-bootstrap` application, which will restore all of the other applications in your repository. | ||
|
|
||
|
|
||
|
|
||
| ``` | ||
| export GIT_REPO=https://github.com/owner/installation-repo | ||
| export GIT_TOKEN=xxx | ||
| argocd-autopilot repo bootstrap --recover | ||
| ``` | ||
|
|
||
| #### Apply Argo-CD Manifests From Existing Repository | ||
| In some cases where you made [some modifications](./Modifying-Argo-CD.md) to your Argo-CD, you probably want to apply the modified Argo-CD manifests from your repository instead of new ones. You can easily do that with the `--app` flag. | ||
|
|
||
| For example: | ||
| ``` | ||
| export GIT_REPO=https://github.com/owner/installation-repo | ||
| export GIT_TOKEN=xxx | ||
| argocd-autopilot repo bootstrap --recover --app "${GIT_REPO}.git/bootstrap/argo-cd" | ||
| ``` | ||
|
|
||
| This is using the [app specifier](./App-Specifier.md) flag to tell autopilot that the Argo-CD manifests should be generated from `/bootstrap/argo-cd/kustomization.yaml`. | ||
|
|
||
| !!! note | ||
| If you used a different path or branch for your autopilot installation your app specifier would look different |
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