Pharos
| master | Code Climate |
|--------|------|--------------|
| |
|
From an existing Kubernetes application, set the following environment variables and start the server:
PHAROS_SALT_HOST
: IP of the Salt API server.PHAROS_SALT_PORT
: Port of the Salt API server.PHAROS_SALT_USER
: The user allowed to access the Salt API.PHAROS_KUBERNETES_HOST
: IP of the Kubernetes API server.PHAROS_KUBERNETES_PORT
: port of the Kubernetes API server.PHAROS_KUBERNETES_CERT_DIRECTORY
: directory where the Kubernetes certificates are located.
Development
You can develop on pharos with all its required dependencies right away using the start
script
within the kubernetes
folder. You will need a standalone kubelet running in your machine.
Start the development container
> cd kubernetes
> ./start
This will start the pharos container as well as other required containers.
If you want to use your own set of salt states you can provide SALT_DIR
environment variable
to the start script, so that directory will be used as salt root.
Your pharos folder will be mounted on the pharos container, so any change you do locally to pharos
will be seen inside the container. Once that the service is up, you should be able to see the
pharos service at http://localhost:3000/
on your local machine.
After any change that you have performed you can run any rails/rake task as if it was local, with
the docker prefix, like docker exec -it $(docker ps | grep pharos-dashboard | awk '{print $1}') bash -c "RAILS_ENV=test rspec"
or docker exec -it $(docker ps | grep pharos-dashboard | awk '{print $1}') bash -c "RAILS_ENV=test rubocop"
.
Licensing
Pharos is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.