You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-41Lines changed: 11 additions & 41 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,60 +23,31 @@ The Controller is the central API server for [Deis Workflow][workflow]. It is in
23
23
24
24
# Development
25
25
26
-
The Deis project welcomes contributions from all developers. The highlevel process for development matches many other open source projects. See below for an outline.
26
+
The Deis project welcomes contributions from all developers. The high-level process for development matches many other open source projects. See below for an outline.
27
27
28
28
* Fork this repository
29
29
* Make your changes
30
30
*[Submit a pull request][prs] (PR) to this repository with your changes, and unit tests whenever possible.
31
31
* If your PR fixes any [issues][issues], make sure you write Fixes #1234 in your PR description (where #1234 is the number of the issue you're closing)
32
-
* The Deis core contributors will review your code. After each of them sign off on your code, they'll label your PR with LGTM1 and LGTM2 (respectively). Once that happens, the contributors will merge it
32
+
* Deis project maintainers will review your code.
33
+
* After two maintainers approve it, they will merge your PR.
33
34
34
35
## Prerequisites
35
36
37
+
### Docker
38
+
39
+
Unit tests and code linters for controller run in a Docker container with your local code directory
40
+
mounted in. You need [Docker][] to run `make test`.
41
+
36
42
### Kubernetes
37
43
38
-
In order to do development on this component, you'll need a working Kubernetes cluster. If you don't have one, follow the [installation instructions][install-k8s] and note that Controller currently targets version 1.2 and higher.
44
+
You'll want to test your code changes interactively in a working Kubernetes cluster. Follow the
45
+
[installation instructions][install-k8s] if you need Kubernetes.
39
46
40
47
### Workflow Installation
41
48
42
49
After you have a working Kubernetes cluster, you're ready to [install Workflow](https://deis.com/docs/workflow/installing-workflow/).
43
50
44
-
### Postgresql
45
-
46
-
The application and tests use PostgreSQL. To start a local instance via Docker, run `make postgres` and set the following in your shell:
47
-
```
48
-
export DEIS_DATABASE_SERVICE_HOST=`docker-machine ip $(docker-machine active) 2>/dev/null || echo 127.0.0.1`
49
-
export DEIS_DATABASE_SERVICE_PORT=5432
50
-
export DEIS_DATABASE_USER=postgres
51
-
```
52
-
53
-
### Python
54
-
55
-
Python 3.5.2 is a minimum requirement and can be installed via `pyenv`:
56
-
57
-
```
58
-
brew install pyenv
59
-
```
60
-
61
-
- After installing, ensure [`eval "$(pyenv init -)"` is added to your shell startup.](https://github.com/yyuu/pyenv/#homebrew-on-mac-os-x)
62
-
- Install and use Python 3.5.2:
63
-
```
64
-
pyenv install 3.5.2
65
-
# if you have build issues, ensure Xcode CLI tools are installed:https://github.com/yyuu/pyenv/issues/451#issuecomment-151336786
66
-
pyenv local 3.5.2 # use Python 3.5.2 in your current directory
67
-
```
68
-
69
-
Or via your package manager. For example, on Debian Jessie:
70
-
71
-
```
72
-
apt-get install python3 python3-dev python3-venv
73
-
```
74
-
75
-
With the correct Python in place the quickest way to get up and running is to run `make setup-venv` which will install the Python specific dependencies via [PIP](https://pip.pypa.io/en/stable/) inside an isolated [virtualenv][virtualenv].
76
-
Running `python --version` to verify the correct version is recommend.
77
-
78
-
Follow the linked documentation to learn about [virtualenv][virtualenv] and how to `activate` and `deactivate` the environment.
79
-
80
51
## Testing Your Code
81
52
82
53
When you've built your new feature or fixed a bug, make sure you've added appropriate unit tests and run `make test` to ensure your code works properly.
@@ -114,8 +85,7 @@ Unless required by applicable law or agreed to in writing, software distributed
0 commit comments