Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/janus-idp/operator
Operator for Backstage, based on the Operator SDK framework
https://github.com/janus-idp/operator
backstage backstage-operator janus-idp kubernetes kubernetes-operator kubernetes-operator-sdk kubernetes-operators openshift operator operator-sdk
Last synced: about 2 months ago
JSON representation
Operator for Backstage, based on the Operator SDK framework
- Host: GitHub
- URL: https://github.com/janus-idp/operator
- Owner: janus-idp
- License: apache-2.0
- Created: 2023-11-01T12:11:45.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-04-12T17:15:20.000Z (5 months ago)
- Last Synced: 2024-04-12T20:20:53.780Z (5 months ago)
- Topics: backstage, backstage-operator, janus-idp, kubernetes, kubernetes-operator, kubernetes-operator-sdk, kubernetes-operators, openshift, operator, operator-sdk
- Language: Go
- Homepage:
- Size: 1.83 MB
- Stars: 9
- Watchers: 7
- Forks: 11
- Open Issues: 38
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Backstage Operator
## DEPRECATION WARNING
As of August 2024, this repo is deprecated and read-only.
Please continue to work on this project in the following places:
* Code has moved to https://github.com/redhat-developer/rhdh-operator
* Issues can be reported at https://issues.redhat.com/browse/RHIDP
* CI images can be found at https://quay.io/repository/rhdh/rhdh-rhel9-operator?tab=info
## The Goal
The Goal of [Backstage](https://backstage.io) Operator project is creating Kubernetes Operator for configuring, installing and synchronizing Backstage instance on Kubernetes/OpenShift.
The initial target is in support of Red Hat's assemblies of Backstage - specifically supporting [dynamic-plugins](https://github.com/janus-idp/backstage-showcase/blob/main/showcase-docs/dynamic-plugins.md) on OpenShift. This includes [Red Hat Developer Hub (RHDH)](https://developers.redhat.com/rhdh) but may be flexible enough to install any compatible Backstage instance on Kubernetes. See additional information under [Configuration](docs/configuration.md).
The Operator provides clear and flexible configuration options to satisfy a wide range of expectations, from "no configuration for default quick start" to "highly customized configuration for production".
[More documentation...](#more-documentation)
## Getting Started
You’ll need a Kubernetes or OpenShift cluster. You can use [Minikube](https://minikube.sigs.k8s.io/docs/) or [KIND](https://sigs.k8s.io/kind) for local testing, or deploy to a remote cluster.
**Note:** Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster `kubectl cluster-info` shows).
To test it on minikube from the source code:
Both **kubectl** and **minikube** must be installed. See [tools](https://kubernetes.io/docs/tasks/tools/).
1. Get your copy of Operator from GitHub:
```sh
git clone https://github.com/janus-idp/operator
```
2. Deploy Operator on the minikube cluster:
```sh
cd
make deploy
```
you can check if the Operator pod is up by running
```sh
kubectl get pods -n backstage-system
It should be something like:
NAME READY STATUS RESTARTS AGE
backstage-controller-manager-cfc44bdfd-xzk8g 2/2 Running 0 32s
```
3. Create Backstage Custom resource on some namespace (make sure this namespace exists)
```sh
kubectl -n apply -f examples/bs1.yaml
```
you can check if the Operand pods are up by running
```sh
kubectl get pods -n
It should be something like:
NAME READY STATUS RESTARTS AGE
backstage-85fc4657b5-lqk6r 1/1 Running 0 78s
backstage-psql-bs1-0 1/1 Running 0 79s
```
4. Tunnel Backstage Service and get URL for access Backstage
```sh
minikube service -n backstage --url
Output:
>http://127.0.0.1:53245
```
5. Access your Backstage instance in your browser using this URL.
## More documentation
- [Openshift deployment](docs/openshift.md)
- [Configuration](docs/configuration.md)
- [Developer Guide](docs/developer.md)
- [Operator Design](docs/developer.md)
## Telemetry data collection
The telemetry data collection feature is enabled by default. The default configuration uses image with backstage-plugin-analytics-provider-segment plugin enabled and configured. To disable this and to learn what data is being collected, see https://github.com/janus-idp/backstage-showcase/blob/main/showcase-docs/getting-started.md#telemetry-collection
## License
Copyright 2023 Red Hat Inc.
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.