Skip to content

Commit

Permalink
add aws-crossplane-cluster-config-operator-0.3.0-1b36e4d9c16a105584af…
Browse files Browse the repository at this point in the history
…4cd451e098b7668b7a4f.tgz

aws-crossplane-cluster-config-operator-0.3.0-1b36e4d9c16a105584af4cd451e098b7668b7a4f.tgz-meta/README.md
aws-crossplane-cluster-config-operator-0.3.0-1b36e4d9c16a105584af4cd451e098b7668b7a4f.tgz-meta/main.yaml
aws-crossplane-cluster-config-operator-0.3.0-1b36e4d9c16a105584af4cd451e098b7668b7a4f.tgz-meta/values.schema.json
  • Loading branch information
catalogbot committed Nov 6, 2024
1 parent e982cbf commit 78c1012
Show file tree
Hide file tree
Showing 5 changed files with 233 additions and 1 deletion.
Binary file not shown.
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
# aws-crossplane-cluster-config-operator
// TODO(user): Add simple overview of use/purpose

## Description
// TODO(user): An in-depth paragraph about your project and overview of use

## Getting Started
You’ll need a Kubernetes cluster to run against. You can use [KIND](https://sigs.k8s.io/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:

```sh
kubectl apply -f config/samples/
```

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

```sh
make docker-build docker-push IMG=<some-registry>/aws-crossplane-cluster-config-operator:tag
```

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

```sh
make deploy IMG=<some-registry>/aws-crossplane-cluster-config-operator:tag
```

### Uninstall CRDs
To delete the CRDs from the cluster:

```sh
make uninstall
```

### Undeploy controller
UnDeploy the controller to the cluster:

```sh
make undeploy
```

## Contributing
// TODO(user): Add detailed information on how you would like others to contribute to this project

### How it works
This project aims to follow the Kubernetes [Operator pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/)

It uses [Controllers](https://kubernetes.io/docs/concepts/architecture/controller/)
which provides a reconcile function responsible for synchronizing resources untile the desired state is reached on the cluster

### Test It Out
1. Install the CRDs into the cluster:

```sh
make install
```

2. Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running):

```sh
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:

```sh
make manifests
```

**NOTE:** Run `make --help` for more information on all potential `make` targets

More information can be found via the [Kubebuilder Documentation](https://book.kubebuilder.io/introduction.html)

## 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.
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
annotations:
application.giantswarm.io/metadata: https://giantswarm.github.io/control-plane-test-catalog/aws-crossplane-cluster-config-operator-0.3.0-1b36e4d9c16a105584af4cd451e098b7668b7a4f.tgz-meta/main.yaml
application.giantswarm.io/readme: https://giantswarm.github.io/control-plane-test-catalog/aws-crossplane-cluster-config-operator-0.3.0-1b36e4d9c16a105584af4cd451e098b7668b7a4f.tgz-meta/README.md
application.giantswarm.io/team: phoenix
application.giantswarm.io/values-schema: https://giantswarm.github.io/control-plane-test-catalog/aws-crossplane-cluster-config-operator-0.3.0-1b36e4d9c16a105584af4cd451e098b7668b7a4f.tgz-meta/values.schema.json
chartApiVersion: v2
chartFile: aws-crossplane-cluster-config-operator-0.3.0-1b36e4d9c16a105584af4cd451e098b7668b7a4f.tgz
dateCreated: '2024-11-06T17:15:58.811788Z'
digest: 56b8a2c5936952b1ea3bc8fb019998f52e06e9fd03cf2971bd5ae52c2b5b2199
home: https://github.com/giantswarm/aws-crossplane-cluster-config-operator
icon: https://s.giantswarm.io/app-icons/aws/2/dark.svg
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
{
"$schema": "http://json-schema.org/schema#",
"type": "object",
"required": [
"baseDomain",
"providerRole"
],
"properties": {
"baseDomain": {
"type": "string"
},
"global": {
"type": "object",
"properties": {
"podSecurityStandards": {
"type": "object",
"properties": {
"enforced": {
"type": "boolean"
}
}
}
}
},
"image": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"pullPolicy": {
"type": "string"
},
"registry": {
"type": "string"
},
"tag": {
"type": "string"
}
}
},
"pod": {
"type": "object",
"properties": {
"group": {
"type": "object",
"properties": {
"id": {
"type": "string"
}
}
},
"user": {
"type": "object",
"properties": {
"id": {
"type": "string"
}
}
}
}
},
"podSecurityContext": {
"type": "object",
"properties": {
"runAsNonRoot": {
"type": "boolean"
},
"seccompProfile": {
"type": "object",
"properties": {
"type": {
"type": "string"
}
}
}
}
},
"providerRole": {
"type": "string"
},
"securityContext": {
"type": "object",
"properties": {
"allowPrivilegeEscalation": {
"type": "boolean"
},
"capabilities": {
"type": "object",
"properties": {
"drop": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"readOnlyRootFilesystem": {
"type": "boolean"
},
"seccompProfile": {
"type": "object",
"properties": {
"type": {
"type": "string"
}
}
}
}
}
}
}
17 changes: 16 additions & 1 deletion index.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3516,6 +3516,21 @@ entries:
urls:
- https://giantswarm.github.io/control-plane-test-catalog/aws-crossplane-cluster-config-operator-0.3.0-1d84e80d07b32c4928b2de440464e5f4a665cf59.tgz
version: 0.3.0-1d84e80d07b32c4928b2de440464e5f4a665cf59
- annotations:
application.giantswarm.io/metadata: https://giantswarm.github.io/control-plane-test-catalog/aws-crossplane-cluster-config-operator-0.3.0-1b36e4d9c16a105584af4cd451e098b7668b7a4f.tgz-meta/main.yaml
application.giantswarm.io/readme: https://giantswarm.github.io/control-plane-test-catalog/aws-crossplane-cluster-config-operator-0.3.0-1b36e4d9c16a105584af4cd451e098b7668b7a4f.tgz-meta/README.md
application.giantswarm.io/team: phoenix
application.giantswarm.io/values-schema: https://giantswarm.github.io/control-plane-test-catalog/aws-crossplane-cluster-config-operator-0.3.0-1b36e4d9c16a105584af4cd451e098b7668b7a4f.tgz-meta/values.schema.json
apiVersion: v2
created: "2024-11-06T17:16:14.363548721Z"
description: Please add description
digest: 56b8a2c5936952b1ea3bc8fb019998f52e06e9fd03cf2971bd5ae52c2b5b2199
home: https://github.com/giantswarm/aws-crossplane-cluster-config-operator
icon: https://s.giantswarm.io/app-icons/aws/2/dark.svg
name: aws-crossplane-cluster-config-operator
urls:
- https://giantswarm.github.io/control-plane-test-catalog/aws-crossplane-cluster-config-operator-0.3.0-1b36e4d9c16a105584af4cd451e098b7668b7a4f.tgz
version: 0.3.0-1b36e4d9c16a105584af4cd451e098b7668b7a4f
- annotations:
application.giantswarm.io/metadata: https://giantswarm.github.io/control-plane-test-catalog/aws-crossplane-cluster-config-operator-0.3.0-0dc1a51942203c72fb1a4a06f47e4e22e794e642.tgz-meta/main.yaml
application.giantswarm.io/readme: https://giantswarm.github.io/control-plane-test-catalog/aws-crossplane-cluster-config-operator-0.3.0-0dc1a51942203c72fb1a4a06f47e4e22e794e642.tgz-meta/README.md
Expand Down Expand Up @@ -56306,4 +56321,4 @@ entries:
urls:
- https://giantswarm.github.io/control-plane-test-catalog/vertical-pod-autoscaler-crd-0.0.0-9925886a8b029918200779e160c758cfb3c660dc.tgz
version: 0.0.0-9925886a8b029918200779e160c758cfb3c660dc
generated: "2024-11-06T17:16:05.033211243Z"
generated: "2024-11-06T17:16:14.362690621Z"

0 comments on commit 78c1012

Please sign in to comment.