Remove incorrect/missleading documentation left over from v1 (#1608)

- We should update these in the future - We also need to validate all deploy types in new branch/folder structure
cloudfoundry · Feb 12, 2018 · 9b571c6 · 9b571c6
1 parent d5534fb
commit 9b571c6
Show file tree

Hide file tree

Showing 6 changed files with 62 additions and 404 deletions.
diff --git a/README.md b/README.md
@@ -11,7 +11,7 @@
 
 Stratos is an Open Source Web-based UI (Console) for managing Cloud Foundry. It allows users and administrators to both manage applications running in the Cloud Foundry cluster and perform cluster management tasks.
 
-![Stratos Application view](docs/images/screenshots/app-wall.png)
+<!-- ![Stratos Application view](docs/images/screenshots/app-wall.png) -->
 
 ## Deploying Stratos
 
@@ -35,8 +35,8 @@ You can access the UI on `https://localhost:4443`
 
 ## Project Planning
 We use [ZenHub](https://zenhub.com) for project planning. Feel free to head over to the [Boards](https://github.com/SUSE/stratos#boards)
-tab and have a look through our pipelines and milestones. Please note in order to view the ZenHub Boards tab you will need the [ZenHub
-browser extension](https://www.zenhub.com/extension).
+tab and have a look through our pipelines and milestones. Please note in order to view the Github ZenHub Boards tab you will need the [ZenHub
+browser extension](https://www.zenhub.com/extension). Alternatively, to view the planning board without the extension visit our [ZenHub Project Page](https://app.zenhub.com/workspace/o/cloudfoundry-incubator/stratos/boards)
 
 ## Further Reading
 

diff --git a/deploy/cloud-foundry/README.md b/deploy/cloud-foundry/README.md
@@ -2,11 +2,11 @@
 
 ## Deployment Steps
 
-The quickest way to install Stratos UI is to deploy it as a Cloud Foundry application. To do so, clone the `stratos-ui` repository, cd into the newly cloned repository and push to Cloud Foundry. This can be done with:
+The quickest way to install Stratos UI is to deploy it as a Cloud Foundry application. To do so, clone the `stratos` repository, cd into the newly cloned repository and push to Cloud Foundry. This can be done with:
 
 ```
-git clone https://github.com/SUSE/stratos-ui.git
-cd stratos-ui
+git clone https://github.com/cloudfoundry-incubator/stratos
+cd stratos
 cf push
 ```
 
@@ -27,27 +27,8 @@ Note:
 
 1. You need the cf CLI command line tool installed and available on the path.
 2. You need to have configured the cf cli to point to your Cloud Foundry cluster, to be authenticated with your credentials and to be targeted at the organization and space where you want the console application be created.
-3. You may need to configure Application Security Groups on your Cloud Foundry Cluster in order that  Stratos UI can communicate with the Cloud Foundry API. See [below](#application-security-groups) for more information.
-4. The Stratos UI Console will automatically detect the API endpoint for your Cloud Foundry. To do so, it relies on the `cf_api_url` value inside the `VCAP_APPLICATION` environment variable. If this is not provided by your Cloud Foundry platform, then you must manually update the application manifest as described [below](#console-fails-to-start).
-
-## Enable Endpoints Dashboard to register additional Cloud Foundry endpoints
-
-To enable the dashboard add the environment variable 'FORCE_ENDPOINT_DASHBOARD' to the manifest before the call to 'cf push' is made. For example
-
- ```
- applications:
- - name: console
-   memory: 256M
-   disk_quota: 256M
-   host: console
-   timeout: 180
-   buildpack: https://github.com/SUSE/stratos-buildpack
-   health-check-type: port
-   env:
-     FORCE_ENDPOINT_DASHBOARD: true
- ```
-
->**NOTE** This step, on it's own, is meant for demonstration purposes only. Registered endpoints will be lost if the app is restarted and each app instance will have it's own lists. To remove these caveats see the section 'Associate Cloud Foundry database service' below.
+3. You may need to configure Application Security Groups on your Cloud Foundry Cluster in order that  Stratos can communicate with the Cloud Foundry API. See [below](#application-security-groups) for more information.
+4. The Stratos Console will automatically detect the API endpoint for your Cloud Foundry. To do so, it relies on the `cf_api_url` value inside the `VCAP_APPLICATION` environment variable. If this is not provided by your Cloud Foundry platform, then you must manually update the application manifest as described [below](#console-fails-to-start).
 
 ## Associate Cloud Foundry database service
 Follow instructions [here](db-migration/README.md).
@@ -149,7 +130,7 @@ applications:
   disk_quota: 256M
   host: console
   timeout: 180
-  buildpack: https://github.com/SUSE/stratos-buildpack
+  buildpack: https://github.com/cloudfoundry-incubator/stratos-buildpack
   health-check-type: port
   env:
     CF_API_URL: https://<<CLOUD FOUNDRY API ENDPOINT>>>
@@ -166,7 +147,7 @@ applications:
   disk_quota: 256M
   host: console
   timeout: 180
-  buildpack: https://github.com/SUSE/stratos-buildpack
+  buildpack: https://github.com/cloudfoundry-incubator/stratos-buildpack
   health-check-type: port
   env:
     CF_API_FORCE_SECURE: true

diff --git a/docs/developers-guide.md b/docs/developers-guide.md
@@ -116,5 +116,53 @@ Run `npm run e2e` to execute the end-to-end tests via [Protractor](http://www.pr
 ## Backend Development
 
 The backend (more informally called the portal-proxy or 'pp' for short) is still to be ported over from V1 of
-[Stratos](https://github.com/SUSE/stratos-ui). Once that's completed come back and check out this section for instructions on how to
+[Stratos](https://github.com/cloudfoundry-incubator/stratos). Once that's completed come back and check out this section for instructions on how to
 make changes to it.
+
+WIP
+
+### Getting started
+
+The portal-proxy is the back-end for the Console UI. It is written in Go.
+
+### Automatically register and connect to an existing endpoint
+To automatically register a Cloud Foundry add the environment variable below
+
+> **Note** On log in the console will also attempt to auto-connect to the cloud foundry using 
+           the username/password provided.
+
+```
+AUTO_REG_CF_URL=<api url of cf>
+```
+
+This env var can be set in `outputs/config.properties` if running the backend locally in the host machine, `./deploy/proxy.env` if running in docker-compose or `./manifest` if in cf push.
+
+> **NOTE** WIP Instructions!
+
+#### Introduction
+* Golang
+* Dependency Management (Glide)
+
+#### Dependencies
+* go
+  * GOPATH, GOBIN env vars set
+* glide
+* UAA instance
+
+#### Running portal-proxy in a container
+* Follow instructions in the deploy/docker-compose docs
+* To apply changes (build and update docker image) simply run `deploy/tools/restart_proxy.sh`  
+
+#### Running "like a dev"
+
+1. Set up developer certs
+    - Execute `deploy/tools/generate_cert.sh`
+    - Copy `portal-proxy-output/dev-certs` to `./`
+1. Update `build/dev_config.json` with `"localDevBuild": true`
+1. Run `gulp local-dev-build`
+1. cd ./outputs
+1. Run `gulp build-backend`
+1. Update `config.propeties` and ensure that..
+    - the UAA points to a valid instance
+    - the `CONSOLE_CLIENT` and `CONSOLE_ADMIN_SCOPE` are valid in the UAA instance
+1. Run `portal-proxy`