-
Notifications
You must be signed in to change notification settings - Fork 432
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(dev): start hatchery after init token (#5195)
Signed-off-by: Yvonnick Esnault <[email protected]>
- Loading branch information
Showing
1 changed file
with
26 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -82,23 +82,23 @@ $ tar xzf node-v12.4.0-darwin-x64.tar.gz | |
|
||
## Golang | ||
|
||
Download the latest Golang version from https://golang.org/dl/, version >= 1.13 | ||
Download the latest Golang version from https://golang.org/dl/, version >= 1.14 | ||
|
||
Example with version 1.13 on macOS: | ||
Example with version 1.14 on macOS: | ||
|
||
```bash | ||
$ export GOROOT=~/go | ||
$ export PATH=$PATH:$GOROOT/bin | ||
$ cd ~ | ||
$ curl -O https://dl.google.com/go/go1.13.darwin-amd64.tar.gz | ||
$ tar xzf go1.13.darwin-amd64.tar.gz | ||
$ curl -O https://dl.google.com/go/go1.14.darwin-amd64.tar.gz | ||
$ tar xzf go1.14.darwin-amd64.tar.gz | ||
``` | ||
|
||
Check if Go installation is ok | ||
|
||
```bash | ||
$ go version | ||
go version go1.13 darwin/amd64 | ||
go version go1.14 darwin/amd64 | ||
``` | ||
|
||
## CDS | ||
|
@@ -131,11 +131,24 @@ $ engine config new > ~/.cds/dev.toml | |
# edit ~/.cds/dev.toml file | ||
## in section [api] | ||
### --> set variable defaultOS to your OS, darwin if you are on macOS for example | ||
|
||
## in section [hatchery.local.commonConfiguration] | ||
### --> set name to "hatchery-local" | ||
|
||
## in section [hatchery.local.commonConfiguration.api.http] | ||
### --> uncomment url, should be set to url = "http://localhost:8081" | ||
|
||
## in section [hatchery.local] | ||
### basedir = "/tmp/cds" | ||
# this directory will contains the cds workers workspace | ||
|
||
## in section [api.directories] | ||
### baseDirectory = "/your-gopath/src/github.com/ovh/cds/engine/worker/dist" | ||
# this directory should contains the workers binaries | ||
|
||
## in section [api.artifact.local] | ||
# baseDirectory = "/tmp/cds/artifacts" | ||
|
||
``` | ||
|
||
Prepare database: | ||
|
@@ -151,10 +164,10 @@ $ engine database upgrade --db-password cds --db-sslmode disable | |
If you don't have a local PostgreSQL, you should run `engine database upgrade --help` | ||
and update `~/.cds/dev.toml` file. | ||
|
||
Launch CDS engine API & local hatchery: | ||
Launch CDS engine API: | ||
|
||
```bash | ||
$ engine --config ~/.cds/dev.toml start api hatchery:local | ||
$ engine --config ~/.cds/dev.toml start api | ||
``` | ||
|
||
Launch CDS UI: | ||
|
@@ -173,6 +186,12 @@ $ cdsctl signup -H http://localhost:8081 --email [email protected] - | |
# Check CDS API logs to get the validation code | ||
``` | ||
|
||
Launch local hatchery: | ||
|
||
```bash | ||
$ engine --config ~/.cds/dev.toml start hatchery:local | ||
``` | ||
|
||
Open a browser, go on http://localhost:8080 - Have fun. | ||
|
||
## Notes | ||
|