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
+4-7Lines changed: 4 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,9 +2,9 @@
2
2
3
3
**Drycc Workflow** is an open source Platform as a Service (PaaS) that adds a developer-friendly layer to any [Kubernetes][k8s-home] cluster, making it easy to deploy and manage applications.
4
4
5
-
To **get started** with **Drycc Workflow** please read the [Quick Start Guide](https://drycc.cc/docs/workflow/quickstart/).
5
+
To **get started** with **Drycc Workflow** please read the [Quick Start Guide](https://drycc.cc/quickstart/).
6
6
7
-
Visit [https://drycc.cc](https://drycc.cc) for more information on [why you should use Drycc Workflow](https://drycc.cc/why-drycc/) or [learn about its features](https://drycc.cc/how-it-works/).
7
+
Visit [https://drycc.cc](https://drycc.cc) for more information on [why you should use Drycc Workflow](https://drycc.cc/understanding-workflow/concepts/) or [learn about its features](https://drycc.cc/understanding-workflow/architecture/).
8
8
9
9
This repository contains the source code for Drycc Workflow documentation. If you're looking for individual components, they live in their own repositories.
10
10
@@ -13,9 +13,7 @@ Please see below for links and descriptions of each component:
13
13
-[passport](https://github.com/drycc/passport) - Workflow single sign on system
14
14
-[controller](https://github.com/drycc/controller) - Workflow API server
15
15
-[builder](https://github.com/drycc/builder) - Git server and source-to-image component
16
-
-[imagebuilder](https://github.com/drycc/imagebuilder) - The builder for [Docker](https://www.docker.com/) based applications
17
-
-[slugbuilder](https://github.com/drycc/slugbuilder) - The builder for [slug/buildpack](https://devcenter.heroku.com/articles/slug-compiler) based applications
18
-
-[slugrunner](https://github.com/drycc/slugrunner) - The runner for slug/buildpack based applications
16
+
-[imagebuilder](https://github.com/drycc/imagebuilder) - The builder for [Docker](https://www.docker.com/) and [CNCF Buildpacks](https://buildpacks.io/) based applications
19
17
-[fluentd](https://github.com/drycc/fluentd) - Backend log shipping mechanism for `drycc logs`
20
18
-[postgres](https://github.com/drycc/postgres) - The central database
21
19
-[registry](https://github.com/drycc/registry) - The Docker registry
@@ -31,14 +29,13 @@ We welcome your input! If you have feedback, please [submit an issue][issues]. I
The Drycc project welcomes contributions from all developers. The high level process for development matches many other open source projects. See below for an outline.
37
34
38
35
* Fork this repository.
39
36
* Make your changes.
40
37
*[Submit a pull request][prs] (PR) to this repository with your changes, and unit tests whenever possible.
41
-
* 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).
38
+
* 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).
42
39
* The Drycc 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, a contributor will merge it.
DRYCC_DISABLE_CACHE | if set, this will disable the [slugbuilder cache][] (default: not set)
64
-
DRYCC_DEPLOY_BATCHES | the number of pods to bring up and take down sequentially during a scale (default: number of available nodes)
65
-
DRYCC_DEPLOY_TIMEOUT | deploy timeout in seconds per deploy batch (default: 120)
63
+
DRYCC_DISABLE_CACHE | if set, this will disable the [slugbuilder cache][] (default: not set)
64
+
DRYCC_DEPLOY_BATCHES | the number of pods to bring up and take down sequentially during a scale (default: number of available nodes)
65
+
DRYCC_DEPLOY_TIMEOUT | deploy timeout in seconds per deploy batch (default: 120)
66
66
IMAGE_PULL_POLICY | the kubernetes [image pull policy][pull-policy] for application images (default: "IfNotPresent") (allowed values: "Always", "IfNotPresent")
67
67
KUBERNETES_DEPLOYMENTS_REVISION_HISTORY_LIMIT | how many [revisions][kubernetes-deployment-revision] Kubernetes keeps around of a given Deployment (default: all revisions)
68
68
KUBERNETES_POD_TERMINATION_GRACE_PERIOD_SECONDS | how many seconds kubernetes waits for a pod to finish work after a SIGTERM before sending SIGKILL (default: 30)
Drycc supports deploying applications via [Heroku Buildpacks][]. Buildpacks are useful if you're interested in following Heroku's best practices for building applications or if you are deploying an application that already runs on Heroku.
3
+
Drycc supports deploying applications via [Cloud Native Buildpacks](https://buildpacks.io/). Cloud Native Buildpacks are useful if you want to follow [cnb's docs](https://buildpacks.io/docs/)for building applications.
4
4
5
5
## Add SSH Key
6
6
@@ -44,18 +44,43 @@ Use `git push drycc master` to deploy your application.
If, however, you're unable to deploy using the latest version of the buildpack, You can set an exact version of a buildpack by using a git revision in your `.buildpack`. For example: `https://github.com/dpiddy/heroku-buildpack-ruby-minimal#v13`
112
-
113
130
On your next `git push`, the custom buildpack will be used.
114
131
115
-
116
-
## Compile Hooks
117
-
118
-
Sometimes, an application needs a way to stop or check if a service is running before building an
119
-
app, which may require notifying a service that the [Builder][] has finished compiling the app. In
120
-
order to do this, an app can provide two files in their `bin/` directory:
121
-
122
-
```
123
-
bin/pre-compile
124
-
bin/post-compile
125
-
```
126
-
127
-
The builder will run these commands before and after the build process, respectively.
128
-
129
-
130
132
## Using Private Repositories
131
133
132
134
To pull code from private repositories, set the `SSH_KEY` environment variable to a private key
@@ -139,39 +141,34 @@ which has access. Use either the path of a private key file or the raw key mater
139
141
140
142
For example, to use a custom buildpack hosted at a private GitHub URL, ensure that an SSH public
141
143
key exists in your [GitHub settings][]. Then set `SSH_KEY` to the corresponding SSH private key
Copy file name to clipboardExpand all lines: src/installing-workflow/configuring-object-storage.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -44,7 +44,7 @@ Operators should configure object storage by editing the Helm values file before
44
44
All values will be automatically (base64) encoded _except_ the `key_json` values under `gcs`/`gcr`. These must be base64-encoded. This is to support cleanly passing said encoded text via `helm --set` cli functionality rather than attempting to pass the raw JSON data. For example:
Copy file name to clipboardExpand all lines: src/installing-workflow/configuring-postgres.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Configuring Postgres
2
2
3
-
Drycc Workflow's controller component relies on a PostgreSQL database to store platform state.
3
+
Drycc Workflow's controller and passport component rely on a PostgreSQL database to store platform state.
4
4
5
5
By default, Drycc Workflow ships with the [database] component, which provides an in-cluster PostgreSQL database backed up to in-cluster or off-cluster [object storage]. Currently, for object storage, which is utilized by _several_ Workflow components, only off-cluster solutions such as S3 or GCS are recommended in production environments. Experience has shown that many operators already opting for off-cluster object storage similarly prefer to host Postgres off-cluster as well, using Amazon RDS or similar. When excercising both options, a Workflow installation becomes entirely stateless, and is thus restored or rebuilt with greater ease should the need ever arise.
0 commit comments