Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/upbound/platform-ref-cloud-native

The Cloud Native reference platform
https://github.com/upbound/platform-ref-cloud-native

Last synced: 12 months ago
JSON representation

The Cloud Native reference platform

Awesome Lists containing this project

README 

          
# Cloud Native Reference Platform



This reference platform `Configuration` for Cloud Native applications and platform services is a

starting point to build, run, and operate your own internal cloud platform and offer a self-service

console and API to your internal teams.



It provides platform APIs to provision fully configured workload clusters, with secure networking

and a complete set of platform services that provide the foundation for running cloud native

applications.  This is a good example of how a platform team may provide a complete platform for

cloud native applications to run on, which includes continuous deployment, monitoring, metrics,

logging, etc.



The application team simply has to request a "cloud native platform" cluster through this

declarative platform API and they'll be ready to deploy their workloads to a complete platform in no

time.



## Quick Start



### Platform Ops/SRE: Run your own internal cloud platform



There are two ways to run Universal Crossplane:



1. Hosted on Upbound Cloud

1. Self-hosted on any Kubernetes cluster.



To provision the GCP Reference platform, you can pick the option that is best for you. 



We'll go through each option in the next sections.



### Upbound Cloud Hosted UXP Control Plane



Hosted Control planes are run on Upbound's cloud infrastructure and provide a restricted

Kubernetes API endpoint that can be accessed via `kubectl` or CI/CD systems.



#### Create a free account in Upbound Cloud



1. Sign up for [Upbound Cloud](https://cloud.upbound.io/register).

1. When you first create an Upbound Account, you can create an Organization



#### Create a Hosted UXP Control Plane in Upbound Cloud



1. Create a `Control Plane` in Upbound Cloud (e.g. dev, staging, or prod).

1. Connect `kubectl` to your `Control Plane` instance.

   * Click on your Control Plane

   * Select the *Connect Using CLI*

   * Paste the commands to configure your local `kubectl` context

   * Test your connectivity by running `kubectl -n upbound-system get pods`



#### Installing UXP on a Kubernetes Cluster



The other option is installing UXP into a Kubernetes cluster you manage using `up`, which

is the official CLI for interacting with Upbound Cloud and Universal Crossplane (UXP).



There are multiple ways to [install up](https://cloud.upbound.io/docs/cli/#install-script),

including Homebrew and Linux packages.



```console

curl -sL https://cli.upbound.io | sh

```



Ensure that your kubectl context is pointing to the correct cluster:



```console

kubectl config current-context

```



Install UXP into the `upbound-system` namespace:



```console

up uxp install

```



Validate the install using the following command:



```console

kubectl -n upbound-system get all

```



#### Install the Crossplane kubectl extension (for convenience)



Now that your kubectl context is configured to connect to a UXP Control Plane,

we can install this reference platform as a Crossplane package.



```console

curl -sL https://raw.githubusercontent.com/crossplane/crossplane/master/install.sh | sh

cp kubectl-crossplane /usr/local/bin

```



#### Install the Platform Configuration



```console

PLATFORM_VERSION=v0.0.3

PLATFORM_CONFIG=registry.upbound.io/upbound/platform-ref-cloud-native:${PLATFORM_VERSION}



kubectl crossplane install configuration ${PLATFORM_CONFIG}

kubectl get pkg

```



#### GCP Provider Setup



Set up your GCP account keyfile by following the instructions on:

https://crossplane.io/docs/v1.0/getting-started/install-configure.html#select-provider



Ensure that the following roles are added to your service account:



* `roles/compute.networkAdmin`

* `roles/container.admin`

* `roles/iam.serviceAccountUser`



Then create the secret using the given `creds.json` file:



```console

kubectl -n upbound-system create secret generic gcp-creds --from-file=key=./creds.json

```



Create the `ProviderConfig`, ensuring to set the `projectID` to your specific GCP project:



```console

kubectl apply -f examples/provider-default-gcp.yaml

```



#### Invite App Teams to you Organization in Upbound Cloud



1. Create a Team `team1`.

1. Invite app team members and grant access to `Control Planes` and `Repositories`.



### App Dev/Ops: Consume the infrastructure you need using kubectl



#### Join your Organization in Upbound Cloud



1. **Join** your [Upbound Cloud](https://cloud.upbound.io/register)

   `Organization`

1. Verify access to your team `Control Planes` and Registries



#### Provision a Cloud Native platform cluster in your team Workspace GUI console



1. Provision a `Cluster` using the custom generated GUI for your

Platform `Configuration`



```console

kubectl -n upbound-system apply -f examples/cluster-gcp.yaml



```



1. View status / details of the managed resources created for your claim:



```console

kubectl get managed

```



1. Check status of your claim:



```console

kubectl -n upbound-system get clusterclaim

```



### Cleanup & Uninstall



#### Cleanup Resources



There are 2 options to delete resources created through the `Workspace` GUI:



* From the `Workspace` GUI using the ellipsis menu in the resource view.

* Using `kubectl delete -n team1 `.



Verify all underlying resources have been cleanly deleted:



```console

kubectl get managed

```



#### Uninstall Provider & Platform Configuration



```console

kubectl delete configurations.pkg.crossplane.io platform-ref-cloud-native

kubectl delete providers.pkg.crossplane.io provider-gcp

kubectl delete providers.pkg.crossplane.io provider-helm

```



## APIs in this Configuration



* `Cluster` - provision a fully configured Kubernetes cluster

  * [definition.yaml](cluster/definition.yaml)

  * [composition.yaml](cluster/composition.yaml) includes (transitively):

    * `GKECluster`

    * `NodePool`

    * `Network`

    * `Subnetwork`

    * `HelmReleases` for Prometheus, Jaeger, Fluentd, Rook, and Flux platform services.

* `Network` - fabric for a `Cluster` to securely connect the control plane, pods, and services

  * [definition.yaml](network/definition.yaml)

  * [composition.yaml](network/composition.yaml) includes:



## Customize for your Organization



Create a `Repository` called `platform-ref-cloud-native` in your Upbound Cloud `Organization`.



Set these to match your settings:



```console

UPBOUND_ORG=acme

UPBOUND_ACCOUNT_EMAIL=me@acme.io

REPO=platform-ref-cloud-native

VERSION_TAG=v0.0.3

REGISTRY=registry.upbound.io

PLATFORM_CONFIG=${REGISTRY:+$REGISTRY/}${UPBOUND_ORG}/${REPO}:${VERSION_TAG}

```



Clone the GitHub repo.



```console

git clone https://github.com/upbound/platform-ref-cloud-native.git

cd platform-ref-cloud-native

```



Login to your container registry.



```console

docker login ${REGISTRY} -u ${UPBOUND_ACCOUNT_EMAIL}

```



Build package.



```console

up xpkg build --name package.xpkg --ignore ".github/*,.github/*/*,examples/*,hack/*"

```



Push package to registry.



```console

up xpkg build push ${PLATFORM_CONFIG} -f package.xpkg

```



Install package into an Upbound `Platform` instance.



```console

kubectl crossplane install configuration ${PLATFORM_CONFIG}

```



To learn more see [Configuration

Packages](https://crossplane.io/docs/v0.14/getting-started/package-infrastructure.html).



## Learn More



If you're interested in building your own reference platform for your company,

we'd love to hear from you and chat. You can setup some time with us at

info@upbound.io.



For Crossplane questions, drop by [slack.crossplane.io](https://slack.crossplane.io), and say hi!