Skip to content

Latest commit

 

History

History
58 lines (34 loc) · 3.22 KB

README.md

File metadata and controls

58 lines (34 loc) · 3.22 KB
Raw

Azure Service Operator (for Kubernetes)

Build Status

This project is experimental. Expect the API to change. It is not recommended for production environments.

Introduction

An Operator is an application-specific controller that extends the Kubernetes API to create, configure, and manage instances of complex stateful applications on behalf of a Kubernetes user. It builds upon the basic Kubernetes resource and controller concepts but includes domain or application-specific knowledge to automate common tasks.

(For more details about operators, we recommend Introducing Operators: Putting Operational Knowledge into Software).

This repository contains the resources and code to provision and deprovision different Azure services using a Kubernetes operator.

The Azure Operator comprises of:

  • The Custom Resource Definitions (CRDs) for each of the Azure services that the Kubernetes user can provision
  • The Kubernetes controller that watches for requests to create Custom Resources for these CRDs and creates them

The project was built using Kubebuilder.

For more details on the architecture and control flow of the Azure Service operator, refer to the link below

Azure Service Operator Architecture

Install the operator

This project maintains releases of the Azure Service Operator that you can deploy via a configurable Helm chart.

Azure Services supported

  1. Resource Group
  2. EventHub
  3. Azure SQL

For more information on troubleshooting resources, refer to this link

Building the operators

You can also build, test, and run the operator from source by following these instructions.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

For more specific information on the GIT workflow and guidelines to follow, check here.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.