diff --git a/www/README.md b/www/README.md index e5e8c844953..dc4db788872 100644 --- a/www/README.md +++ b/www/README.md @@ -30,7 +30,7 @@ Bower components should be refernced in one of the `vendor.json` files below: ### Serving the app during development -The app can be served through `kubectl`, but for some types of review a local web server is convenient. One can be installed as follows: +For development you can serve the files locally by installing a webserver as follows: ``` sudo npm install -g http-server @@ -43,6 +43,9 @@ cd app http-server -a localhost -p 8000 ``` +### Serving the app in production +https:///static/app/ + ### Configuration #### Configuration settings A json file can be used by `gulp` to automatically create angular constants. This is useful for setting per environment variables such as api endpoints. @@ -57,7 +60,6 @@ www/master ├── shared/config/development.json └── components ├── dashboard/config/development.json - ├── graph/config/development.json └── my_component/config/development.json ``` produces ```www/master/shared/config/generated-config.js```: @@ -66,14 +68,16 @@ angular.module('kubernetesApp.config', []) .constant('ENV', { '/': , 'dashboard': , - 'graph': , 'my_component': }); ``` #### Kubernetes server configuration -**RECOMMENDED**: By default the Kubernetes api server does not support CORS, +You'll need to run ```hack/build-ui.sh``` to create a new ```pkg/ui/datafile.go``` file. +This is the file that is built-in to the kube-apiserver. + +**RECOMMENDED**: When working in development mode the Kubernetes api server does not support CORS, so the `kube-apiserver.service` must be started with `--cors_allowed_origins=.*` or `--cors_allowed_origins=http://` @@ -87,7 +91,7 @@ angular.module('kubernetesApp.config', []) See [master/components/README.md](master/components/README.md). ### Testing -Currently kuberntes-ui includes both unit-testing (run via [Karma](http://karma-runner.github.io/0.12/index.html)) and +Currently kuberntes/www includes both unit-testing (run via [Karma](http://karma-runner.github.io/0.12/index.html)) and end-to-end testing (run via [Protractor](http://angular.github.io/protractor/#/)).