Skip to content

Commit dfb2ace

Browse files
author
lijianguo
committed
chore(docs): maintenance update
1 parent 8f93f63 commit dfb2ace

10 files changed

Lines changed: 31 additions & 28 deletions

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ Please see below for links and descriptions of each component:
2020
- [registry](https://github.com/drycc/registry) - The Docker registry
2121
- [logger](https://github.com/drycc/logger) - The (in-memory) log buffer for `drycc logs`
2222
- [monitor](https://github.com/drycc/monitor) - The platform monitoring components
23+
- [influxdb](https://github.com/drycc/influxdb) - The monitor database
24+
- [rabbitmq](https://github.com/drycc/rabbitmq) - RabbitMQ is a message broker used with controller celery
2325
- [minio](https://github.com/drycc/minio) - The in-cluster, ephemeral, development-only object storage system
2426
- [nsq](https://github.com/drycc/nsq) - Realtime distributed messaging platform
2527
- [workflow-cli](https://github.com/drycc/workflow-cli) - Workflow CLI `drycc`

src/applications/managing-app-lifecycle.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ $ drycc perms:create otheruser
8080
Adding otheruser to peachy-waxworks collaborators... done
8181
```
8282

83-
Use `drycc perms` to see who an application is currently shared with, and `drycc perms:remove` to remove a collaborator.
83+
Use `drycc perms` to see who an application is currently shared with, and `drycc perms:delete` to remove a collaborator.
8484

8585
!!! note
8686
Collaborators can do anything with an application that its owner can do, except delete the application.

src/applications/using-buildpacks.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -101,16 +101,14 @@ are pushing.
101101

102102
## Using a Custom Buildpack
103103

104-
To use a custom buildpack, set the `BUILDPACK_URL` environment variable.
104+
To use a custom buildpack, you need create a `.buildpack` file in your root path app.
105105

106-
$ drycc config:set BUILDPACK_URL=https://github.com/dpiddy/heroku-buildpack-ruby-minimal
107-
Creating config... done, v2
108-
109-
=== humble-autoharp
110-
BUILDPACK_URL: https://github.com/dpiddy/heroku-buildpack-ruby-minimal
106+
$ tee > .buildpack << EOF
107+
> https://github.com/dpiddy/heroku-buildpack-ruby-minimal
108+
> EOF
111109

112110
!!! note
113-
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_URL`. For example: `BUILDPACK_URL=https://github.com/dpiddy/heroku-buildpack-ruby-minimal#v13`
111+
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`
114112

115113
On your next `git push`, the custom buildpack will be used.
116114

@@ -141,10 +139,13 @@ which has access. Use either the path of a private key file or the raw key mater
141139

142140
For example, to use a custom buildpack hosted at a private GitHub URL, ensure that an SSH public
143141
key exists in your [GitHub settings][]. Then set `SSH_KEY` to the corresponding SSH private key
144-
and set `BUILDPACK_URL` to the URL:
142+
and set `.buildpack` to the URL:
145143

146-
$ drycc config:set SSH_KEY=/home/user/.ssh/github_id_rsa
147-
$ drycc config:set BUILDPACK_URL=git@github.com:user/private_buildpack.git
144+
$ tee > .buildpack << EOF
145+
> https://github.com/dpiddy/heroku-buildpack-ruby-minimal
146+
> EOF
147+
$ git add .buildpack
148+
$ git commit -m "chore(buildpack): modify the buildpack url"
148149
$ git push drycc master
149150

150151
## Builder selector

src/installing-workflow/chart-provenance.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,16 +34,16 @@ Charts signed with this key can then be verified when fetched:
3434
$ helm repo add drycc https://charts.drycc.cc/stable
3535
"drycc" has been added to your repositories
3636
37-
$ helm fetch --verify drycc/workflow --version v2.17.0
38-
Verification: &{0xc420704c80 sha256:a2a140dca075a2eabe20422f1aa5bc1ce210b18a326472d6b2708e1a93afebea workflow-v2.17.0.tgz}
37+
$ helm fetch --verify drycc/workflow --version v1.0.0
38+
Verification: &{0xc420704c80 sha256:a2a140dca075a2eabe20422f1aa5bc1ce210b18a326472d6b2708e1a93afebea workflow-v1.0.0.tgz}
3939
```
4040

41-
One can then inspect the fetched `workflow-v2.17.0.tgz.prov` provenance file.
41+
One can then inspect the fetched `workflow-v1.0.0.tgz.prov` provenance file.
4242

4343
If the chart was not signed, the command above would result in:
4444

4545
```
46-
Error: Failed to fetch provenance "https://charts.drycc.cc/stable/workflow/workflow-v2.17.0.tgz.prov"
46+
Error: Failed to fetch provenance "https://charts.drycc.cc/stable/workflow/workflow-v1.0.0.tgz.prov"
4747
```
4848

4949
Alternatively, the chart can also be verified at install time:

src/installing-workflow/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Installing Drycc Workflow
22

3-
This document is aimed at those who have already provisioned a [Kubernetes v1.12+][] cluster
3+
This document is aimed at those who have already provisioned a [Kubernetes v1.16.15+][] cluster
44
and want to install Drycc Workflow. If help is required getting started with Kubernetes and
55
Drycc Workflow, follow the [quickstart guide](../quickstart/index.md) for assistance.
66

@@ -136,5 +136,5 @@ Once all of the pods are in the `READY` state, Drycc Workflow is up and running!
136136

137137
After installing Workflow, [register a user and deploy an application](../quickstart/deploy-an-app.md).
138138

139-
[Kubernetes v1.3.4+]: system-requirements.md#kubernetes-versions
139+
[Kubernetes v1.16.15+]: system-requirements.md#kubernetes-versions
140140
[helm]: https://github.com/kubernetes/helm/blob/master/docs/install.md

src/managing-workflow/platform-monitoring.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ A production install of Grafana should have the following configuration values c
5858

5959

6060
### On Cluster Persistence
61-
Enabling persistence will allow your custom configuration to persist across pod restarts. This means that the default sqllite database (which stores things like sessions and user data) will not disappear if you upgrade the Workflow installation.
61+
Enabling persistence will allow your custom configuration to persist across pod restarts. This means that the default sqllite database (which stores things like sessions and user data) will not disappear if you upgrade the Workflow installation.
6262

6363
If you wish to have persistence for Grafana you can set `enabled` to `true` in the `values.yaml` file before running `helm install`.
6464

@@ -92,13 +92,13 @@ If you wish to have persistence for InfluxDB you can set `enabled` to `true` in
9292

9393
### Off Cluster Influxdb
9494

95-
To use off-cluster Influx, please provide the following values in the `values.yaml` file before running `helm install`.
95+
To use off-cluster Influx v2, please provide the following values in the `values.yaml` file before running `helm install`.
9696

9797
* `influxdb_location=off-cluster`
9898
* `url = "http://my-influxhost.com:8086"`
99-
* `database = "metrics"`
100-
* `user = "InfluxUser"`
101-
* `password = "MysuperSecurePassword"`
99+
* `bucket = "metrics"`
100+
* `org = "drycc"`
101+
* `token = "MysuperSecurePassword"`
102102

103103

104104
## [Telegraf](https://docs.influxdata.com/telegraf)

src/managing-workflow/upgrading-workflow.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ drycc-rabbitmq-0 1/1 Running 0 5m
8282
Users of Drycc Workflow should now upgrade their drycc client to avoid getting `WARNING: Client and server API versions do not match. Please consider upgrading.` warnings.
8383

8484
```
85-
curl -sSL https://raw.githubusercontent.com/drycc/workflow-cli/main/install-v2.sh | bash -s v2.20.0 && sudo mv drycc $(which drycc)
85+
curl -sSL https://raw.githubusercontent.com/drycc/workflow-cli/main/install.tmpl | bash -s v1.1.0 && sudo mv drycc $(which drycc)
8686
```
8787

8888

src/quickstart/install-cli-tools.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Use the CLI to create and configure and manage applications.
55

66
Install the `drycc` client for Linux or Mac OS X with:
77

8-
$ curl -sSL https://raw.githubusercontent.com/drycc/workflow-cli/main/install.tmpl | bash -s v1.0.1
8+
$ curl -sSL https://raw.githubusercontent.com/drycc/workflow-cli/main/install.tmpl | bash -s v1.1.0
99

1010
Others please visit: https://github.com/drycc/workflow-cli/releases
1111

@@ -21,7 +21,7 @@ should move it somewhere in your $PATH:
2121
Check your work by running `drycc version`:
2222

2323
$ drycc version
24-
v2.17.0
24+
v1.1.0
2525

2626
!!! note
2727
Note that version numbers may vary as new releases become available

src/roadmap/releases.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ verify it can be fetched (and verified):
137137
$ helm repo add controller https://charts.drycc.cc/stable
138138
"controller" has been added to your repositories
139139
$ helm fetch --verify drycc/controller --version v1.0.1
140-
Verification: &{0xc4207ec870 sha256:026e766e918ff28d2a7041bc3d560d149ee7eb0cb84165c9d9d00a3045ff45c3 controller-v2.17.0.tgz}
140+
Verification: &{0xc4207ec870 sha256:026e766e918ff28d2a7041bc3d560d149ee7eb0cb84165c9d9d00a3045ff45c3 controller-v1.0.1.tgz}
141141
```
142142

143143
## How to Release Workflow
@@ -252,7 +252,7 @@ Kick off https://ci.drycc.info/job/workflow-cli-build-stable/ with the `TAG` bui
252252
and then verify `stable` artifacts are available and appropriately updated after the job completes:
253253

254254
```
255-
$ curl -sSL https://raw.githubusercontent.com/drycc/workflow-cli/main/install-v2.sh | bash -s v2.20.0
255+
$ curl -sSL https://raw.githubusercontent.com/drycc/workflow-cli/main/install.tmpl | bash -s v1.1.0
256256
$ ./drycc version
257257
# (Should show $WORKFLOW_RELEASE)
258258
```

src/users/cli.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ with Drycc Workflow.
77

88
Install the latest `drycc` client for Linux or Mac OS X with:
99

10-
$ curl -sSL https://raw.githubusercontent.com/drycc/workflow-cli/main/install-v2.sh | bash -s v2.20.0
10+
$ curl -sSL https://raw.githubusercontent.com/drycc/workflow-cli/main/install.tmpl | bash -s v1.1.0
1111

1212
The installer puts `drycc` in your current directory, but you should move it
1313
somewhere in your $PATH:

0 commit comments

Comments
 (0)