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 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 on OpenShift. This includes Red Hat Developer Hub (RHDH) but may be flexible enough to install any compatible Backstage instance on Kubernetes. See additional information under Configuration. 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...

Getting Started

You’ll need a Kubernetes or OpenShift cluster. You can use Minikube or 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.

1. Get your copy of Operator from GitHub:

   git clone https://github.com/janus-idp/operator

2. Deploy Operator on the minikube cluster:

   cd <your-rhdh-operator-project-dir>
   make deploy

   you can check if the Operator pod is up by running

   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)

   kubectl -n <your-namespace> apply -f examples/bs1.yaml

   you can check if the Operand pods are up by running

   
   kubectl get pods -n <your-namespace>
   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 <your-namespace> backstage --url
Output:
>http://127.0.0.1:53245

5. Access your Backstage instance in your browser using this URL.

More documentation

• Openshift deployment
• Configuration
• Developer Guide
• Operator Design

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.