valid8or-plugin-aws

README

valid8or-plugin-aws

The AWS valid8or plugin ensures that your AWS environment matches a user-configurable expected state.

Description

The AWS valid8or plugin reconciles AwsValidator custom resources to perform the following validations against your AWS environment:

1. Compare the IAM permissions associated with an IAM user / group / role / policy against an expected permission set
2. Compare the usage for a particular service quota against the active quota
3. Compare the tags associated with a subnet against an expected tag set

Each AwsValidator CR is (re)-processed every two minutes to continuously ensure that your AWS environment matches the expected state.

See the samples directory for example AwsValidator configurations.

Supported Service Quotas by AWS Service

EC2:

• EC2-VPC Elastic IPs
• Public AMIs

EFS:

• File systems per account

ELB:

• Application Load Balancers per Region
• Classic Load Balancers per Region
• Network Load Balancers per Region

VPC:

• Internet gateways per Region
• Network interfaces per Region
• VPCs per Region
• NAT gateways per Availability Zone
• Subnets per VPC

Installation

The AWS valid8or plugin is meant to be installed by valid8or (via a Valid8orConfig), but it can also be installed directly as follows:

helm repo add valid8or-plugin-aws https://spectrocloud-labs.github.io/valid8or-plugin-aws
helm repo update
helm install valid8or-plugin-aws valid8or-plugin-aws/valid8or-plugin-aws -n valid8or-plugin-aws --create-namespace

Getting Started

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

1. Install Instances of Custom Resources:

kubectl apply -f config/samples/

1. Build and push your image to the location specified by IMG:

make docker-build docker-push IMG=<some-registry>/valid8or-plugin-aws:tag

1. Deploy the controller to the cluster with the image specified by IMG:

make deploy IMG=<some-registry>/valid8or-plugin-aws:tag

Uninstall CRDs

To delete the CRDs from the cluster:

make uninstall

Undeploy controller

UnDeploy the controller from the cluster:

make undeploy

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

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

1. Install the CRDs into the cluster:

make install

1. 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

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.