Skip to content

Commit

Permalink
Readme updates (#20)
Browse files Browse the repository at this point in the history
* Update README.md

* Update README.md

* Update README.md

* docs(marketplace): adopt docs for marketplace

Signed-off-by: Christopher Haar <christopher.haar@upbound.io>

---------

Signed-off-by: Christopher Haar <christopher.haar@upbound.io>
Co-authored-by: Christopher Haar <christopher.haar@upbound.io>
  • Loading branch information
tr0njavolta and haarchri authored Feb 16, 2024
1 parent 26128d4 commit 23da09b
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 2 deletions.
41 changes: 39 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,39 @@
# configuration-azure-aks
Azure AKS Configuration
# Azure AKS Configuration


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 [Azure AKS](https://azure.microsoft.com/en-us/products/kubernetes-service) instances.

## Overview

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.

In this specific configuration, the AKS API contains:

- **an [AKS](/apis/definition.yaml) custom resource type.**
- **Composition of the AKS resources:** Configured in [/apis/composition.yaml](/apis/composition.yaml), it provisions an AKS cluster and resources 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-azure-aks
spec:
package: xpkg.upbound.io/upbound/configuration-azure-aks:v0.3.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.
5 changes: 5 additions & 0 deletions crossplane.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@ metadata:
meta.crossplane.io/maintainer: Upbound <support@upbound.io>
meta.crossplane.io/source: github.com/upbound/configuration-azure-aks
meta.crossplane.io/license: Apache-2.0
meta.crossplane.io/description: |
Azure AKS Configuration is reusable Configuration designed to be primarily used in higher level Configurations.
meta.crossplane.io/readme: |
This configuration bundles an Upbound Cloud extension and an API definition. This API allows control planes to provision Azure AKS clusters, composed using cloud service primitives from the Upbound Official Providers
spec:
crossplane:
version: ">=v1.14.1-0"
Expand Down

0 comments on commit 23da09b

Please sign in to comment.