Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bentoml/yatai-image-builder
🐳 Build OCI images for Bentos in k8s
https://github.com/bentoml/yatai-image-builder
container container-image docker docker-image k8s kubernetes
Last synced: 3 months ago
JSON representation
🐳 Build OCI images for Bentos in k8s
- Host: GitHub
- URL: https://github.com/bentoml/yatai-image-builder
- Owner: bentoml
- Created: 2022-11-04T11:46:42.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-24T05:03:41.000Z (3 months ago)
- Last Synced: 2024-09-27T01:52:22.991Z (3 months ago)
- Topics: container, container-image, docker, docker-image, k8s, kubernetes
- Language: Go
- Homepage:
- Size: 534 KB
- Stars: 14
- Watchers: 7
- Forks: 9
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# yatai-image-builder
yatai-image-builder is a yatai component dedicated to building container images for Bento
## Description
yatai-image-builder runs in k8s, it is the operator of `BentoRequest` CRD, it is responsible for reconcile `BentoRequest` CR and then build the image for Bento, after the image is built `Bento` CR is generated, [yatai-deployment](https://github.com/bentoml/yatai-deployment) component will depend on Bento CR to deploy Bento in k8s
## 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=/yatai-image-builder:tag
```
3. Deploy the controller to the cluster with the image specified by `IMG`:
```sh
make deploy IMG=/yatai-image-builder: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
Contributing code or documentation to the project by submitting a Github pull request. Check out the [Development Guide](https://github.com/bentoml/yatai-image-builder/blob/main/DEVELOPMENT.md).
### 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 start-dev
```
**NOTE:** The more information you should check the [Development Guide](https://github.com/bentoml/yatai-image-builder/blob/main/DEVELOPMENT.md).
### 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 2022.
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.