Skip to content

Commit

Permalink
description & README
Browse files Browse the repository at this point in the history
  • Loading branch information
tr0njavolta committed Feb 5, 2024
1 parent 4537740 commit e26557e
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,20 @@
# GitOps Flux Configuration
# Flux Configuration

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.

This repository contains a [Crossplane 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.
- **Composition(s):** Implements the API by orchestrating a set of Crossplane managed resources.

In this specific configuration, the Flux API contains:

In this specific configuration, the [Flux] API contains:
- **an Flux (/apis/definition.yaml) custom resource type.**
- **Composition of the Flux resources:** Configured in [/apis/composition.yaml](/apis/composition.yaml), it provisions an Flux resources in the `upbound-system` namespace.

- **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.

Expand All @@ -22,9 +24,9 @@ This repository contains an Composite Resource (XR) file.
apiVersion: pkg.crossplane.io/v1
kind: Configuration
metadata:
name: configuration-gitops-flux
name: PACKAGE NAME
spec:
package: xpkg.upbound.io/upbound/configuration-gitops-flux:v0.2.0
package: PACKAGE SPEC
```

## Next steps
Expand All @@ -35,4 +37,4 @@ This repository serves as a foundational step. To enhance your control plane, co
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.
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.

0 comments on commit e26557e

Please sign in to comment.