Consul is a distributed, highly available, and data center aware solution to connect and configure applications across dynamic, distributed infrastructure.

consul api-gateway kubernetes ecs service-discovery service-mesh vault

Tree: 8d140ce9af

History

John Cowen 604de8758b ui: Fix using 'ui-like' KVs when using an empty default nspace (#7734 ) When using namespaces, the 'default' namespace is a little special in that we wanted the option for all our URLs to stay the same when using namespaces if you are using the default namespace, with the option of also being able to explicitly specify `~default` as a namespace. In other words both `ui/services/service-name` and `ui/~default/services/service-name` show the same thing. This means that if you switch between OSS and Enterprise, all of your URLs stay the same, but you can still specifically link to the default namespace itself. Our routing configuration is duplicated in order to achieve this: ``` - :dc - :service - :kv - :edit - :nspace - :dc - :service - :kv - :edit ``` Secondly, ember routing resolves/matches routes in the order that you specify them, unless, its seems, when using wildcard routes, like we do in the KV area. When not using the wildcard routes the above routing configuration resolves/matches a `/dc-1/kv/service` to the `dc.kv.edit` route correctly (dc:dc-1, kv:services), that route having been configured in a higher priority than the nspace routes. However when configured with wildcards (required in the KV area), note the asterisk below: ``` - :dc :service - :kv - edit - :nspace - :dc - :service - :kv - edit ``` Given something like `/dc-1/kv/services` the router instead matches the `nspace.dc.service` (nspace:dc-1, dc:kv, service:services) route first even though the `dc.kv.edit` route should still match first. Changing the `dc.kv.edit` route back to use a non-wildcard route (:edit instead of *edit), returns the router to match the routes in the correct order. In order to work around this, we catch any incorrectly matched routes (those being directed to the nspace Route but not having a `~` character in the nspace parameter), and then recalculate the correct route name and parameters. Lastly we use this recalculated route to direct the user/app to the correct route. This route recalcation requires walking up the route to gather up all of the required route parameters, and although this feels like something that could already exist in ember, it doesn't seem to. We had already done a lot of this work a while ago when implementing our `href-mut` helper. This commit therefore repurposes that work slighlty and externalizes it outside of the helper itself into a more usable util so we can import it where we need it. Tests have been added before refactoring it down to make the code easier to follow.		5 years ago
..
app	ui: Fix using 'ui-like' KVs when using an empty default nspace (#7734 )	5 years ago
blueprints	ui: Adds ember-data blueprints for Consul specific HTTP adapter etc (#6461 )	5 years ago
config	ui: Run 2 separate test runs oss and ent (#7214 )	5 years ago
lib	ui: Move slots to use attributes over positional params (#7032 )	5 years ago
node-tests/config	ui: Run 2 separate test runs oss and ent (#7214 )	5 years ago
public	ui: serve /robots.txt when UI is enabled. (#5089 )	6 years ago
tests	ui: Fix using 'ui-like' KVs when using an empty default nspace (#7734 )	5 years ago
.dev.eslintrc.js	…
.editorconfig	…
.ember-cli	ui: [dev] Adds express middleware, removes need to run api dev server (#6750 )	5 years ago
.eslintignore	ui: UI Release Merge (ui-staging merge) (#6527 )	5 years ago
.eslintrc.js	ui: UI Release Merge (ui-staging merge) (#6527 )	5 years ago
.gitignore	ui: UI Release Merge (ui-staging merge) (#6527 )	5 years ago
.nvmrc	ui: Upgrade tooling to node 10 now we are on a more recent ember (#6610 )	5 years ago
.prettierrc	…
.template-lintrc.js	ui: UI Release Merge (ui-staging merge) (#6527 )	5 years ago
.watchmanconfig	…
GNUmakefile	ui: Run 2 separate test runs oss and ent (#7214 )	5 years ago
README.md	ui: [dev] Adds express middleware, removes need to run api dev server (#6750 )	5 years ago
_redirects	ui: Netlify previews (#6419 )	5 years ago
ember-cli-build.js	ui: Discovery Chain (#6746 )	5 years ago
package.json	ui: Run 2 separate test runs oss and ent (#7214 )	5 years ago
testem.js	ui: UI Release Merge (ui-staging merge) (#6527 )	5 years ago
yarn.lock	ui: Discovery chain improvements (#7222 )	5 years ago

README.md

consul-ui

Prerequisites

You will need the following things properly installed on your computer.

Installation

git clone https://github.com/hashicorp/consul.git this repository
cd ui-v2
yarn install

All tooling scripts below primarily use make which in turn call node package scripts.

Running / Development

The source code comes with a small development mode that runs enough of the consul API as a set of mocks/fixtures to be able to run the UI without having to run consul.

make start or yarn start to start the ember app
Visit your app at http://localhost:4200.

To enable ACLs using the mock API, use Web Inspector to set a cookie as follows:

CONSUL_ACLS_ENABLE=1

This will enable the ACLs login page, to which you can login with any ACL token/secret.

You can also use a number of other cookie key/values to set various things whilst developing the UI, such as (but not limited to):

CONSUL_SERVICE_COUNT=1000
CONSUL_NODE_CODE=1000
// etc etc

See ./node_modules/@hashicorp/consul-api-double for more details.

If you wish to run the UI code against a running consul instance, uncomment the proxy line in .ember-cli to point ember-cli to your consul instance.

You can also run the UI against a normal Consul installation.

make start-consul or yarn run start:consul will use the CONSUL_HTTP_ADDR environment variable to locate the Consul installation. If that it not set start-consul will use http://localhost:8500.

Example usage:

CONSUL_HTTP_ADDR=http://10.0.0.1:8500 make start-consul

Code Generators

Make use of the many generators for code, try ember help generate for more details

Running Tests

Please note: You do not need to run make start-api/yarn run start:api to run the tests, but the same mock consul API is used.

make test or yarn run test
make test-view or yarn run test:view to view the tests running in Chrome

Linting

make lint currently runs linting on the majority of js files and hbs files (using ember-template-lint).

See .eslintrc.js and .eslintignore for specific configuration.

Building

make build builds the UI for production usage (env=production)
make build-ci builds the UI for CI/test usage (env=test)

Static files are built into ./dist

Running Tests in Parallel

Alternatively, ember-exam can be used to split the tests across multiple browser instances for faster results. Most options are the same as ember test. To see a full list of options, run ember exam --help.

Note: The EMBER_EXAM_PARALLEL environment variable must be set to override the default parallel value of 1 browser instance in testem.js.

To quickly run the tests across 4 parallel browser instances:

make test-parallel

To run manually:

$ EMBER_EXAM_PARALLEL=true ./node_modules/.bin/ember exam --split <num> --parallel

More ways to split tests can be found in the ember-exam README.md.