azure-service-operator

README

Azure Service Operator v2

Manage your Azure resources from within your Kubernetes cluster.

Azure Service Operator (ASO) allows you to deploy and maintain a wide variety of Azure Resources using the Kubernetes tooling you already know and use.

Instead of deploying and managing your Azure resources separately from your Kubernetes application, ASO allows you to manage them together, automatically configuring your application as needed. For example, ASO can set up your Redis Cache or PostgreSQL database server and then configure your Kubernetes application to use them.

Project Status

This project is stable. We follow the Kubernetes definition of stable.

Why use Azure Service Operator v2?

• K8s Native: we provide CRDs and Golang API structures to deploy and manage Azure resources through Kubernetes.
• Azure Native: our CRDs understand Azure resource lifecycle and model it using K8s garbage collection via ownership references.
• Cloud Scale: we generate K8s CRDs from Azure Resource Manager schemas to move as fast as Azure.
• Async Reconciliation: we don't block on resource creation.

What resources does ASO v2 support?

ASO supports more than 150 different Azure resources, with more added every release. See the full list of supported resources.

Getting Started

[!IMPORTANT] The examples here assume the use of bash or a compatible shell on Linux, WSL or MacOS. If you are working on Windows (e.g. Powershell or CMD), you will need to adjust the commands accordingly. Our documentation provides examples for other shells.

Prerequisites

1. A Kubernetes cluster (at least version 1.16) created and running. You can check your cluster version with kubectl version. If you want to try it out quickly, spin up a local cluster using Kind.
2. An Azure Subscription to provision resources into.
3. An Azure Service Principal for the operator to use, or the Azure CLI to create one. How to create a Service Principal is covered in installation. See the Azure Workload Identity setup for how to use managed identity instead. We recommend using workload identity in production.

Installation

1. Install cert-manager on the cluster using the following command.

   kubectl apply -f https://github.com/jetstack/cert-manager/releases/download/v1.14.4/cert-manager.yaml
   

   Check that the cert-manager pods have started successfully before continuing.

   $ kubectl get pods -n cert-manager
   NAME                                      READY   STATUS    RESTARTS   AGE
   cert-manager-5597cff495-lmphj             1/1     Running   0          1m
   cert-manager-cainjector-bd5f9c764-gvxm4   1/1     Running   0          1m
   cert-manager-webhook-c4b5687dc-x66bj      1/1     Running   0          1m
   

   (Alternatively, you can wait for cert-manager to be ready with cmctl check api --wait=2m - see the cert-manager documentation for more information about cmctl.)

2. Create an Azure Service Principal. You'll need this to grant Azure Service Operator permissions to create resources in your subscription.

   First, set the following environment variables to your Azure Tenant ID and Subscription ID with your values:

   AZURE_TENANT_ID=<your-tenant-id-goes-here>
   AZURE_SUBSCRIPTION_ID=<your-subscription-id-goes-here>
   

   You can find these values by using the Azure CLI: az account show

   Next, create a service principal with Contributor permissions for your subscription.

   You can optionally use a service principal with a more restricted permission set (for example contributor to just a Resource Group), but that will restrict what you can do with ASO. See using reduced permissions for more details.

   az ad sp create-for-rbac -n azure-service-operator --role contributor \
       --scopes /subscriptions/$AZURE_SUBSCRIPTION_ID
   

   This should give you output like the following:

   "appId": "xxxxxxxxxx",
   "displayName": "azure-service-operator",
   "name": "http://azure-service-operator",
   "password": "xxxxxxxxxxx",
   "tenant": "xxxxxxxxxxxxx"
   

   Once you have created a service principal, set the following variables to your app ID and password values:

   AZURE_CLIENT_ID=<your-client-id> # This is the appID from the service principal we created.
   AZURE_CLIENT_SECRET=<your-client-secret> # This is the password from the service principal we created.
   

3. Install the latest v2+ Helm chart:

   helm repo add aso2 https://raw.githubusercontent.com/Azure/azure-service-operator/main/v2/charts
   

   helm upgrade --install aso2 aso2/azure-service-operator \
        --create-namespace \
        --namespace=azureserviceoperator-system \
        --set azureSubscriptionID=$AZURE_SUBSCRIPTION_ID \
        --set azureTenantID=$AZURE_TENANT_ID \
        --set azureClientID=$AZURE_CLIENT_ID \
        --set azureClientSecret=$AZURE_CLIENT_SECRET \
        --set crdPattern='resources.azure.com/*;containerservice.azure.com/*;keyvault.azure.com/*;managedidentity.azure.com/*;eventhub.azure.com/*'
   

   [!WARNING] ASO does not install all available CRDs by default, so ensure you set the crdPattern variable to include the CRDs you are interested in using.
   You can use --set crdPattern=* to install all the CRDs, but be aware of the limits of the Kubernetes you are running.
   Using * is not recommended on AKS Free-tier clusters.

   See CRD management for more details.

   Alternatively you can install from the release YAML directly.

   To learn more about other authentication options, see the authentication documentation.

Usage

Once the controller has been installed in your cluster, you should be able to run the following:

$ kubectl get pods -n azureserviceoperator-system
NAME                                                READY   STATUS    RESTARTS   AGE
azureserviceoperator-controller-manager-5b4bfc59df-lfpqf   2/2     Running   0          24s

# check out the logs for the running controller
$ kubectl logs -n azureserviceoperator-system azureserviceoperator-controller-manager-5b4bfc59df-lfpqf manager 

# let's create an Azure ResourceGroup in westcentralus with the name "aso-sample-rg"
cat <<EOF | kubectl apply -f -
apiVersion: resources.azure.com/v1alpha1api20200601
kind: ResourceGroup
metadata:
  name: aso-sample-rg
  namespace: default
spec:
  location: westcentralus
EOF
# resourcegroup.resources.azure.com/aso-sample-rg created

# let's see what the ResourceGroup resource looks like
$ kubectl describe resourcegroups/aso-sample-rg
Name:         aso-sample-rg
Namespace:    default
Labels:       <none>
Annotations:  resource-id.azure.com: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/aso-sample-rg
              resource-sig.azure.com: 1e3a37c42f6beadbe23d53cf0d271f02d2805d6e295a7e13d5f07bda1fc5b800
API Version:  resources.azure.com/v1alpha1api20200601
Kind:         ResourceGroup
Metadata:
  Creation Timestamp:  2021-08-23T23:59:06Z
  Finalizers:
    serviceoperator.azure.com/finalizer
  Generation:  1
Spec:
  Azure Name:  aso-sample-rg
  Location:    westcentralus
Status:
  Conditions:
    Last Transition Time:  2021-08-23T23:59:13Z
    Reason:                Succeeded
    Status:                True
    Type:                  Ready
  Id:                      /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/aso-sample-rg
  Location:                westcentralus
  Name:                    aso-sample-rg
  Provisioning State:      Succeeded
Events:
  Type    Reason             Age   From                     Message
  ----    ------             ----  ----                     -------
  Normal  BeginDeployment    32s   ResourceGroupController  Created new deployment to Azure with ID "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Resources/deployments/k8s_1629763146_19a8f8c2-046e-11ec-8e54-3eec50af7c79"
  Normal  MonitorDeployment  32s   ResourceGroupController  Monitoring Azure deployment ID="/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Resources/deployments/k8s_1629763146_19a8f8c2-046e-11ec-8e54-3eec50af7c79", state="Accepted"
  Normal  MonitorDeployment  27s   ResourceGroupController  Monitoring Azure deployment ID="/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Resources/deployments/k8s_1629763146_19a8f8c2-046e-11ec-8e54-3eec50af7c79", state="Succeeded"


# delete the ResourceGroup
$ kubectl delete resourcegroups/aso-sample-rg
# resourcegroup.resources.azure.com "aso-sample-rg" deleted

For samples of additional resources, see the resource samples directory.

Tearing it down

[!WARNING] If you kubectl delete an Azure resource from your cluster, ASO will delete the matching Azure resource. This can be dangerous if you were to do this with an existing resource group which contains resources you do not wish to be deleted.

If you want to delete the resources you've created, just kubectl delete each of the Azure resources.

If you want to delete the cluster resource without affecting the Azure resource, apply the annotation serviceoperator.azure.com/reconcile-policy: skip first.

As for deleting controller components, just kubectl delete -f the release manifests you created to get started. For example, creating and deleting cert-manager.

# remove the cert-manager components
kubectl delete -f https://github.com/jetstack/cert-manager/releases/download/v1.14.4/cert-manager.yaml

How to contribute

To get started developing or contributing to the project, follow the instructions in the contributing guide.