Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/appuio/control-api
APPUiO Cloud Control API
https://github.com/appuio/control-api
api appuio appuio-cloud kubernetes vshn-project-apub
Last synced: 12 days ago
JSON representation
APPUiO Cloud Control API
- Host: GitHub
- URL: https://github.com/appuio/control-api
- Owner: appuio
- License: apache-2.0
- Created: 2021-12-06T15:05:26.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-12-22T17:12:36.000Z (15 days ago)
- Last Synced: 2024-12-22T18:22:57.849Z (15 days ago)
- Topics: api, appuio, appuio-cloud, kubernetes, vshn-project-apub
- Language: Go
- Homepage: https://kb.vshn.ch/appuio-cloud/references/architecture/control-api.html
- Size: 871 KB
- Stars: 3
- Watchers: 7
- Forks: 0
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
[![Build](https://img.shields.io/github/workflow/status/appuio/control-api/Test)](https://github.com/appuio/control-api/actions?query=workflow%3ATest)
![Go version](https://img.shields.io/github/go-mod/go-version/appuio/control-api)
![Kubernetes version](https://img.shields.io/badge/k8s-v1.23-blue)
[![Version](https://img.shields.io/github/v/release/appuio/control-api)](https://github.com/appuio/control-api/releases)
[![Maintainability](https://img.shields.io/codeclimate/maintainability/appuio/control-api)](https://codeclimate.com/github/appuio/control-api)
[![GitHub downloads](https://img.shields.io/github/downloads/appuio/control-api/total)](https://github.com/appuio/control-api/releases)# control-api
## Generate Kubernetes code
If you make changes to the CRD structs you'll need to run code generation.
This can be done with make:```bash
make generate
```## Building
See `make help` for a list of build targets.
* `make build`: Build binary for linux/amd64
* `make build -e GOOS=darwin -e GOARCH=arm64`: Build binary for macos/arm64
* `make build.docker`: Build Docker image for local environment## Install CRDs
CRDs can be installed on the cluster by running `kubectl apply -k config/crd/apiextensions.k8s.io/v1`.
## Local development environment
You can setup a [kind]-based local environment with
```bash
make local-env-setup
```See the [local-env/README.md](./local-env/README.md) for more details on the local environment setup.
Please be aware that the productive deployment of the control-api may run on a different Kubernetes distribution than [kind].
[kind]: https://kind.sigs.k8s.io/
### Running the control-api API server locally
You can run the control-api API server locally against the currently configured Kubernetes cluster with
```bash
make run-api
```To access the locally running API server, you need to register it with the [kind]-based local environment.
You can do this by applying the following.The `externalName` needs to be changed to your specific host IP.
When running kind on Linux you can find it with `docker inspect`.On some docker distributions the host IP is accessible via `host.docker.internal`.
```bash
HOSTIP=$(docker inspect control-api-v1.25.3-control-plane | jq '.[0].NetworkSettings.Networks.kind.Gateway')
# HOSTIP=host.docker.internal # On some docker distributionscat <