Skip to content

Commit

Permalink
Update Readme.md (#82)
Browse files Browse the repository at this point in the history
Update docs with new infomation

@lyft/command-center @mistercrunch
  • Loading branch information
hughhhh authored and lyft-buildnotify-2 committed Dec 4, 2017
1 parent 5be156e commit baa7276
Showing 1 changed file with 5 additions and 60 deletions.
65 changes: 5 additions & 60 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,68 +1,15 @@
# Superset

Internal visualization tool for interactively exploring lyft data using [apache/incubator-superset](https://github.com/apache/incubator-superset)
Internal visualization tool for interactively exploring lyft data using [apache/incubator-superset](https://github.com/apache/incubator-superset).

## Running
### Running in devbox

To start the service, run `control start -g superset.dev` While in development, the service loads examples and creates an admin with credentials username and password equal to `admin` and `password`, respectively.

## Intialization

Create a new admin user
To start the service, run the following command
```bash
make create_admin
$ control start -g superset.dev
```

Load examples
```bash
make init_examples
```

## Requirements
* `requirements.txt` for Python dependencies: remember to update `lyft-stdlib` to the [latest version](https://github.com/lyft/python-lyft-stdlib/releases)

## Configuration
Configuration is handled via environment variables. See `app.settings` and
`ops/config/pillar/env.sls`.

## Does your service require envoy?

If this service is intended to receive calls from other services, it needs to be added into our
internal routing configurations. You should familiarize yourself with the envoy documentation
found [here](https://github.com/lyft/envoy-private/blob/master/docs/getting_started.md)


### Develop and test superset in Devbox

See [devbox](https://github.com/lyft/devbox).


### Integrate superset in our Jenkins system

Commit and push the service addition to the primary list in the **ops** directory. Create a PR.

```bash
cd ops.git/
git commit -a -m 'Add superset service to the list'
git push origin add_superset_service
```

Get your PR reviewed and :rocket:. See the #base-train Slack channel for deploy schedule.

After a few minutes all the service Jenkins jobs for continuous integration as well as the service deployment pipeline are available in Jenkins.

### Publish superset git repository to Github

Create a repository in github named superset.

Push the local repository to github:

```bash
cd superset/
git push --set-upstream --force origin master
```

Add the Dev team to the [list of repository collaborators](https://github.com/lyft/superset/settings/collaboration).
While in development, the service loads examples and creates an admin with credentials username and password equal to `admin` and `password`, respectively.

### Deploy to staging and production environments

Expand All @@ -77,8 +24,6 @@ Assign a onebox through the [onebox-assign job](https://jenkins-onebox.lyft.net/

The superset profile will start by default the local and superset containers. If other services/containers are needed add them to the [jenkins profiles file](https://github.com/lyft/ops/blob/master/base/ops/config/pillar/profiles.sls) and [deploy with the base pipeline](https://jenkins.lyft.net/view/base-deploy).

## Reference

### Resolving dependencies and libraries

There's no need to run pip locally. Salt will handle all of these for you.
Expand Down

0 comments on commit baa7276

Please sign in to comment.