validator-plugin-azure
The Azure validator plugin ensures that your Azure environment matches a user-configurable expected state.
Description
The Azure validator plugin reconciles AzureValidator
custom resources to perform the following validations against your Azure environment:
- Compare the Azure RBAC permissions associated with a security principal against an expected permission set.
Each AzureValidator
CR is (re)-processed every two minutes to continuously ensure that your Azure environment matches the expected state.
See the samples directory for example AzureValidator
configurations.
Authn & Authz
Authentication details for the Azure validator controller are provided within each AzureValidator
custom resource. Azure authentication can be configured either implicitly or explicitly:
- Implicit (
AzureValidator.auth.implicit == true
)
- Explicit (
AzureValidator.auth.implicit == false && AzureValidator.auth.secretName != ""
)
[!NOTE]
See values.yaml for additional configuration details for each authentication option.
Minimal Azure RBAC permissions by validation type
For validation to succeed, certain Azure RBAC permissions must be assigned to the principal used via role assignments. The minimal required operations that must be listed under Actions
in the role assignments are as follows:
Microsoft.Authorization/denyAssignments/read
Microsoft.Authorization/roleAssignments/read
Microsoft.Authorization/roleDefinitions/read
If you want to use a built-in role instead of a custom role to provide these permissions, you can use Managed Identity Operator
.
Installation
The Azure validator plugin is meant to be installed by validator (via a ValidatorConfig), but it can also be installed directly as follows:
helm repo add validator-plugin-azure https://spectrocloud-labs.github.io/validator-plugin-azure
helm repo update
helm install validator-plugin-azure validator-plugin-azure/validator-plugin-azure -n validator-plugin-azure --create-namespace
Development
You’ll need a Kubernetes cluster to run against. You can use kind to get a local cluster for testing, or run against a remote cluster.
Note: Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster kubectl cluster-info
shows).
Running on the cluster
- Install Instances of Custom Resources:
kubectl apply -f config/samples/
- Build and push your image to the location specified by
IMG
:
make docker-build docker-push IMG=<some-registry>/validator-plugin-azure:tag
- Deploy the controller to the cluster with the image specified by
IMG
:
make deploy IMG=<some-registry>/validator-plugin-azure:tag
Uninstall CRDs
To delete the CRDs from the cluster:
make uninstall
Undeploy controller
UnDeploy the controller from the cluster:
make undeploy
How it works
This project aims to follow the Kubernetes Operator pattern.
It uses Controllers, which provide a reconcile function responsible for synchronizing resources until the desired state is reached on the cluster.
Test It Out
- Install the CRDs into the cluster:
make install
- Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running):
make run
NOTE: You can also run this in one step by running: make install run
Modifying the API definitions
If you are editing the API definitions, generate the manifests such as CRs or CRDs using:
make manifests
Contributing
All contributions are welcome! Feel free to reach out on the Spectro Cloud community Slack.
Make sure pre-commit
is installed.
Install the pre-commit
scripts:
pre-commit install --hook-type commit-msg
pre-commit install --hook-type pre-commit
NOTE: Run make --help
for more information on all potential make
targets
More information can be found via the Kubebuilder Documentation
License
Copyright 2023.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.