-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
e90a464
commit 4537740
Showing
1 changed file
with
36 additions
and
2 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 |
---|---|---|
@@ -1,4 +1,38 @@ | ||
# GitOps Flux Configuration | ||
|
||
GitOps Flux Configuration is reusable Configuration designed to be primarily used in | ||
higher level Configurations. | ||
This repository contains a [configuration](https://docs.crossplane.io/v1.11/concepts/packages/#configuration-packages), tailored for users establishing their initial control plane with [Upbound](https://cloud.upbound.io). This configuration deploys fully managed Flux instances, allowing you to integrate GitOps practices into your workflow. | ||
|
||
## Overview | ||
|
||
The core components of a custom API in [Crossplane](https://docs.crossplane.io/v1.11/getting-started/introduction/) include: | ||
|
||
- **CompositeResourceDefinition (XRD):** Defines the API's structure. | ||
- **Composition(s):** Implements the API by orchestrating a set of managed resources. | ||
|
||
In this specific configuration, the [Flux] API contains: | ||
|
||
- **an [](/apis/definition.yaml) custom resource type.** | ||
- **Composition of the [] resources:** Configured in [/apis/composition.yaml](/apis/composition.yaml), it provisions an [] cluster and fundamental security and networking resources in the `upbound-system` namespace. | ||
|
||
This repository contains an Composite Resource (XR) file. | ||
|
||
## Deployment | ||
|
||
```shell | ||
apiVersion: pkg.crossplane.io/v1 | ||
kind: Configuration | ||
metadata: | ||
name: configuration-gitops-flux | ||
spec: | ||
package: xpkg.upbound.io/upbound/configuration-gitops-flux:v0.2.0 | ||
``` | ||
|
||
## Next steps | ||
|
||
This repository serves as a foundational step. To enhance your control plane, consider: | ||
|
||
1. create new API definitions in this same repo | ||
2. editing the existing API definition to your needs | ||
|
||
|
||
Upbound will automatically detect the commits you make in your repo and build the configuration package for you. To learn more about how to build APIs for your managed control planes in Upbound, read the guide on Upbound's docs. |