From b7519b60927cd73d2fd0c25360c49038b6406bae Mon Sep 17 00:00:00 2001 From: "R. Sharp" <8883519+tr0njavolta@users.noreply.github.com> Date: Sun, 4 Feb 2024 18:10:27 -0500 Subject: [PATCH 1/5] Update README.md --- README.md | 40 ++++++++++++++++++++++++++++++++++++++-- 1 file changed, 38 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e82595f..e0ae472 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,39 @@ -# configuration-gcp-database +# [] Configuration -GCP Database Configuration is reusable Configuration designed to be primarily used in higher level Configurations. + +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 []() instances. + +## 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 Crossplane managed resources. + +In this specific configuration, the [EKS] API contains: + +- **an [](/apis/definition.yaml) custom resource type.** +- **Composition of the [] resources:** Configured in [/apis/composition.yaml](/apis/composition.yaml), it provisions an [] and 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: PACKAGE NAME +spec: + package: PACKAGE SPEC +``` + +## 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. From 33a1f59e56b8e133f486d6be16ce7d03a6fa3c51 Mon Sep 17 00:00:00 2001 From: Sharp <8883519+tr0njavolta@users.noreply.github.com> Date: Sun, 4 Feb 2024 21:28:14 -0500 Subject: [PATCH 2/5] description & README --- README.md | 14 ++++++++------ crossplane.yaml | 6 ++++++ 2 files changed, 14 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index e0ae472..053c997 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,9 @@ -# [] Configuration -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 []() instances. +# GCP database Configuration + + +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 GCP database instances. ## Overview @@ -10,10 +12,10 @@ The core components of a custom API in [Crossplane](https://docs.crossplane.io/v - **CompositeResourceDefinition (XRD):** Defines the API's structure. - **Composition(s):** Implements the API by orchestrating a set of Crossplane managed resources. -In this specific configuration, the [EKS] API contains: +In this specific configuration, the GCP database API contains: -- **an [](/apis/definition.yaml) custom resource type.** -- **Composition of the [] resources:** Configured in [/apis/composition.yaml](/apis/composition.yaml), it provisions an [] and resources in the `upbound-system` namespace. +- **an GCP database (/apis/definition.yaml) custom resource type.** +- **Composition of the GCP database resources:** Configured in [/apis/composition.yaml](/apis/composition.yaml), it provisions an GCP databaseand resources in the `upbound-system` namespace. This repository contains an Composite Resource (XR) file. @@ -36,4 +38,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. \ No newline at end of file diff --git a/crossplane.yaml b/crossplane.yaml index 1b3fa78..856a724 100644 --- a/crossplane.yaml +++ b/crossplane.yaml @@ -6,6 +6,12 @@ metadata: meta.crossplane.io/maintainer: Upbound meta.crossplane.io/source: github.com/upbound/configuration-gcp-database meta.crossplane.io/license: Apache-2.0 + meta.crossplane.io/description: | + This configuration provides a foundation to build and operate GCP database resources. + meta.crossplane.io/readme: | + This configuration is used for deploying and managing GCP databaseclusters on Kubernetes using Crossplane. This setup provides the necessary infrastructure to deploy GCP database resources managed with Crossplane in Kubernetes. This approach ensures a flexible, streamlined deployment workflow. + + For more details and customization options, you can explore [the GitHub repository](https://github.com/upbound/configuration-app). spec: crossplane: From e50ccb50bb5f7553482a58a60944ce3a927400f1 Mon Sep 17 00:00:00 2001 From: "R. Sharp" <8883519+tr0njavolta@users.noreply.github.com> Date: Mon, 5 Feb 2024 11:13:06 -0500 Subject: [PATCH 3/5] Update README.md --- README.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 053c997..3a3ffaf 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,3 @@ - - # GCP database Configuration @@ -14,7 +12,7 @@ The core components of a custom API in [Crossplane](https://docs.crossplane.io/v In this specific configuration, the GCP database API contains: -- **an GCP database (/apis/definition.yaml) custom resource type.** +- **an [GCP database](/apis/definition.yaml) custom resource type.** - **Composition of the GCP database resources:** Configured in [/apis/composition.yaml](/apis/composition.yaml), it provisions an GCP databaseand resources in the `upbound-system` namespace. This repository contains an Composite Resource (XR) file. @@ -25,9 +23,9 @@ This repository contains an Composite Resource (XR) file. apiVersion: pkg.crossplane.io/v1 kind: Configuration metadata: - name: PACKAGE NAME + name: configuration-gcp-database spec: - package: PACKAGE SPEC + package: xpkg.upbound.io/upbound/configuration-gcp-database:v0.1.0 ``` ## Next steps @@ -38,4 +36,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. \ No newline at end of file +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. From 6a231f60308017c8b1ce9063af63a04a1dd0d4d6 Mon Sep 17 00:00:00 2001 From: "R. Sharp" <8883519+tr0njavolta@users.noreply.github.com> Date: Wed, 7 Feb 2024 08:10:30 -1000 Subject: [PATCH 4/5] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3a3ffaf..60dab6f 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ # GCP database Configuration -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 GCP database instances. +This repository contains a [Crossplane configuration](https://docs.crossplane.io/latest/concepts/packages/#configuration-packages), tailored for users establishing their initial control plane with [Upbound](https://cloud.upbound.io). This configuration deploys fully managed GCP database instances. ## Overview -The core components of a custom API in [Crossplane](https://docs.crossplane.io/v1.11/getting-started/introduction/) include: +The core components of a custom API in [Crossplane](https://docs.crossplane.io/latest/getting-started/introduction/) include: - **CompositeResourceDefinition (XRD):** Defines the API's structure. - **Composition(s):** Implements the API by orchestrating a set of Crossplane managed resources. From 0505a6719b1c42eba0051498ba182c8c837b7e20 Mon Sep 17 00:00:00 2001 From: "R. Sharp" <8883519+tr0njavolta@users.noreply.github.com> Date: Tue, 13 Feb 2024 10:23:58 -0500 Subject: [PATCH 5/5] Apply suggestions from code review Co-authored-by: Yury Tsarev --- crossplane.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/crossplane.yaml b/crossplane.yaml index 856a724..073cfd2 100644 --- a/crossplane.yaml +++ b/crossplane.yaml @@ -9,9 +9,9 @@ metadata: meta.crossplane.io/description: | This configuration provides a foundation to build and operate GCP database resources. meta.crossplane.io/readme: | - This configuration is used for deploying and managing GCP databaseclusters on Kubernetes using Crossplane. This setup provides the necessary infrastructure to deploy GCP database resources managed with Crossplane in Kubernetes. This approach ensures a flexible, streamlined deployment workflow. + This configuration is used for deploying and managing GCP database clusters using Crossplane. This setup provides the necessary infrastructure to deploy GCP database resources managed with Crossplane in Kubernetes. This approach ensures a flexible, streamlined deployment workflow. - For more details and customization options, you can explore [the GitHub repository](https://github.com/upbound/configuration-app). + For more details and customization options, you can explore [the GitHub repository](https://github.com/upbound/configuration-gcp-database). spec: crossplane: