Updating GUI docs
Change-Id: Ia251d76960a1f1df6836d8d7b7f5942e33abcd95
diff --git a/conf/app/style.config.opencloud.js b/conf/app/style.config.mcord.js
similarity index 66%
rename from conf/app/style.config.opencloud.js
rename to conf/app/style.config.mcord.js
index eb93365..41947b5 100644
--- a/conf/app/style.config.opencloud.js
+++ b/conf/app/style.config.mcord.js
@@ -18,15 +18,23 @@
angular.module('app')
.constant('StyleConfig', {
- projectName: 'OpenCloud',
- favicon: 'opencloud-favicon.png',
- background: 'opencloud-bg.jpg',
+ projectName: 'M-CORD',
+ favicon: 'cord-favicon.png',
+ background: 'mcord-bg.jpg',
payoff: 'Your OS resource manager',
- logo: 'opencloud-logo.png',
+ logo: 'cord-logo.png',
routes: [
{
- label: 'Slices',
- state: 'xos.core.slice'
- }
+ label: 'Slices',
+ state: 'xos.core.slice',
+ },
+ {
+ label: 'Nodes',
+ state: 'xos.core.node',
+ },
+ {
+ label: 'Instances',
+ state: 'xos.core.instance',
+ },
]
});
diff --git a/docs/developer/quickstart.md b/docs/developer/quickstart.md
index 6e94799..6a87bc8 100644
--- a/docs/developer/quickstart.md
+++ b/docs/developer/quickstart.md
@@ -1,63 +1,30 @@
# GUI Quickstart
-> NOTE: We assume that you already have the CORD source downloaded with `repo`
+> NOTE: We assume that you already have CORD running. You can refer to the
+[Installation Guide](../../README.md) to get started.
-## Setting up a podconfig
+### Operating the GUI
-For front-end development, using a podconfig with your choice of CORD flavors
-and the `mock` or `local` scenario is sufficient. `mock` will create a
-vagrant VM running all the necessary containers, while `local` directly creates
-the containers on your machine, so we recommend using `mock` when developing on
-your own laptop/desktop.
-
-Assuming you have already downloaded and ran the `cord-bootstrap.sh` script,
-setup is easy:
-
-```bash
-cd ~/cord/build/
-make PODCONFIG={CORD_FLAVOR}-mock.yml config
-make build |& tee ~/build.out
-```
-
-Further details on the mock configuration and its setup can be found at [Mock
-Configuration Workflow](/xos/dev/workflow_mock_single.md)
-
-### Login credentials
-
-After the mock profile finishes building, you can find the credentials
-necessary to login into XOS by running the following:
-
-```shell
-cat ~/cord/build/platform-install/credentials/xosadmin@opencord.org
-// save the output somewhere
-```
+For this, please refer to the [Operation Guide](../../operating_cord/gui.md)
## Serving the GUI in development mode
-Once your basic CORD config is up and running you should be able to access the
-GUI at `http://192.168.46.100/xos/`.
-
-NOTE: This is not your development copy, it is the one deployed inside a
-container in XOS and will not change until the container is torn down and
-redeployed.
-
To launch a development copy:
```shell
// back to your local system
cd cord/orchestration/xos-gui
npm install
-npm start
+PROXY=<cluster-ip>:30006 npm start
```
It will open your default browser at `localhost:3000`, proxy your API request
-to the local environment and watch for file changes.
+to the target environment and watch for file changes.
Now you're ready to start working on it!
-To get start, login using username `xosadmin@opencord.org` and the password you
-previously saved, then pick any file and make a change, and you'll see the GUI
-reload.
+To get start, login using the appropriate credentials,
+then pick any file and make a change, and you'll see the GUI reload.
## Configuring the `dev` GUI
@@ -69,14 +36,6 @@
To load a different configuration file you can use two environment variables:
* `PROXY`: you can use this variable to send request to an arbitrary XOS
- installation (eg: `clnode022.clemson.cloudlab.us:8080`)
+ installation (eg: `192.168.99.100:30006`)
-* `BRAND`: to configure style constants (eg: `cord`, `opencloud`)
-
-## Working with an existing XOS installation
-
-You can also specify a different installation of XOS as backend by using the
-`PROXY` environment variable. For example, you can connect to a remote
-CORD-in-a-box installation for debugging purposes with:
-`PROXY=ms1106.utah.cloudlab.us:8080 npm start`
-
+* `BRAND`: to configure style constants (eg: `cord`, `mcord`)