Skip to content

Commit e1b9050

Browse files
docs: update porch ui installation guide (#3636)
1 parent aa38ca6 commit e1b9050

File tree

1 file changed

+8
-44
lines changed

1 file changed

+8
-44
lines changed

site/guides/porch-ui-installation.md

Lines changed: 8 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,20 @@
11
# Accessing the Configuration as Data UI
22

3-
The easiest way to access the Configuration as Data UI is running by a docker
4-
container on your local machine where you'll be able to access the UI with your
5-
browser. Running the container locally simplifies the overall setup by allowing
6-
the UI to use your local kubeconfig and Google credentials to access the kubernetes
7-
cluster with Porch installed. This guide will show you how to do this.
3+
You can access the Configuration as Data UI UI either by running the UI on a
4+
cluster or integrating the UI into an existing Backstage installation.
85

96
## Prerequisites
107

11-
To access the Configuration as Data UI with a docker container, you will need:
8+
To access the Configuration as Data UI, you will need:
129

13-
* [Porch](guides/porch-installation.md) installed on a kubernetes cluster
14-
* [kubectl](https://kubernetes.io/docs/tasks/tools/) targeting the kubernetes cluster
15-
with Porch installed
16-
* [git](https://git-scm.com/)
17-
* [docker](https://docs.docker.com/get-docker/)
10+
- [Porch](guides/porch-installation.md) installed on a Kubernetes cluster
11+
- [kubectl](https://kubernetes.io/docs/tasks/tools/) targeting the Kubernetes
12+
cluster with Porch installed
13+
- [kpt CLI](https://kpt.dev/installation/kpt-cli) installed
1814

1915
## Running on a GKE cluster
2016

21-
This setup assumes that you have a GKE cluster up and running with porch installed, and that
17+
This setup assumes that you have a GKE cluster up and running with Porch installed, and that
2218
your current kube context is set to that GKE cluster. We would welcome contributions or feedback
2319
from people that have set this up in other clouds outside of GKE.
2420

@@ -137,38 +133,6 @@ kubectl port-forward --namespace=backstage svc/backstage 7007
137133
Open the plugin by browsing to `localhost:7007/config-as-data`. On the plugin, you will need to sign in to your
138134
Google account so that the plugin can access your GKE cluster.
139135

140-
## Running locally in a container
141-
142-
This setup is intended for those developing the plugin. These instructions assume GKE and workload identity,
143-
to simplify authentication configuration, but we would welcome contributions or feedback from people that have set
144-
this up in other clouds.
145-
146-
First, clone the
147-
[kpt-backstage-plugins](https://github.com/GoogleContainerTools/kpt-backstage-plugins)
148-
repository.
149-
150-
```sh
151-
git clone https://github.com/GoogleContainerTools/kpt-backstage-plugins.git
152-
cd kpt-backstage-plugins
153-
```
154-
155-
Next, build the kpt-backstage-plugins image.
156-
157-
```sh
158-
docker build --target backstage-app-local --tag kpt-backstage-plugins .
159-
```
160-
161-
And create a new container using the kpt-backstage-plugins image. The two
162-
attached volumnes allows the UI to connect to your GKE using your local Google
163-
credentials, and the UI will be exposed over port 7007.
164-
165-
```sh
166-
docker run -v ~/.kube/config:/root/.kube/config -v ~/.config/gcloud:/root/.config/gcloud -p 7007:7007 kpt-backstage-plugins
167-
```
168-
169-
And now access the Configuration as Data UI by opening your browser to
170-
http://localhost:7007/config-as-data.
171-
172136
## Running in Backstage
173137

174138
This setup is intended for those installing the plugin into existing backstage deployments.

0 commit comments

Comments
 (0)