Skip to content

Commit 7ebe82e

Browse files
ameowliaameowlia
committed
fix broken links
1 parent b9e265d commit 7ebe82e

20 files changed

+37
-70
lines changed

‎docs/010-overview.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ tags: [diego-release, bbs]
88

99
Diego is Cloud Foundry's next generation container runtime, and the BBS server is its central orchestrator.
1010

11-
The BBS accepts client requests from both inside and outside a Diego cluster, dispatching work to the [auctioneer](http://github.com/cloudfoundry/auctioneer) so it can balance work among the [cells](cells.md). In Diego, there are two distinct types of work:
11+
The BBS accepts client requests from both inside and outside a Diego cluster, dispatching work to the [auctioneer](http://github.com/cloudfoundry/auctioneer) so it can balance work among the [cells](011-cells.md). In Diego, there are two distinct types of work:
1212

13-
- [**Tasks**](tasks.md) are one-off processes that Diego guarantees will run at most once.
14-
- [**Long-Running Processes**](lrps.md) (LRPs) are processes that Diego monitors for health continually. Diego can distribute, run, and monitor several identical instances of a given LRP. When an LRP instance crashes, Diego restarts it automatically.
13+
- [**Tasks**](020-tasks.md) are one-off processes that Diego guarantees will run at most once.
14+
- [**Long-Running Processes**](030-lrps.md) (LRPs) are processes that Diego monitors for health continually. Diego can distribute, run, and monitor several identical instances of a given LRP. When an LRP instance crashes, Diego restarts it automatically.
1515

16-
Tasks and LRP instances run in [Garden](http://github.com/cloudfoundry-incubator/garden) containers on Diego Cells. The filesystem mounted into these containers can be either a 'preloaded' rootfs colocated with the Diego cell or an arbitrary Docker image. Diego also provides some additional [environment variables](environment.md) to processes running in its containers.
16+
Tasks and LRP instances run in [Garden](http://github.com/cloudfoundry-incubator/garden) containers on Diego Cells. The filesystem mounted into these containers can be either a 'preloaded' rootfs colocated with the Diego cell or an arbitrary Docker image. Diego also provides some additional [environment variables](051-environment.md) to processes running in its containers.
1717

1818
In addition to launching and monitoring Tasks and LRPs, Diego streams logs from containers and cells to end users via the [Loggregator system](http://github.com/cloudfoundry/loggregator). Diego also allows clients to store routing data on LRPs. In Cloud Foundry, routing tiers such as the [HTTP Gorouter](http://github.com/cloudfoundry/gorouter) and the [TCP router](https://github.com/cloudfoundry-incubator/cf-tcp-router) use this data to route external traffic to container processes.
1919

20-
Diego provides only a basic notion of client multitenancy via the concept of a [domain](domains.md). Enforcement of richer multitenancy, such as quotas for organizations or visibility restrictions for different users, falls on the [Cloud Controller](http://github.com/cloudfoundry/cloud_controller_ng) in the case of Cloud Foundry.
20+
Diego provides only a basic notion of client multitenancy via the concept of a [domain](050-domains.md). Enforcement of richer multitenancy, such as quotas for organizations or visibility restrictions for different users, falls on the [Cloud Controller](http://github.com/cloudfoundry/cloud_controller_ng) in the case of Cloud Foundry.

‎docs/011-cells.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,5 +33,3 @@ manages containers, and reports app status and other data to the BBS and Loggreg
3333
## Metron Agent
3434

3535
* Forwards application logs, errors, and application and Diego metrics to the Loggregator Doppler component
36-
37-
[back](README.md)

‎docs/012-api-cells.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,4 +50,3 @@ None.
5050
client := bbs.NewClient(url)
5151
cells, err := client.Cells(logger)
5252
```
53-
[back](README.md)

‎docs/020-tasks.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,3 @@ If `ResultFile` was specified and the Task has completed succesfully, `Result` w
101101
#### `Annotation`
102102

103103
This is the arbitrary string that was specified in the TaskDefinition.
104-
105-
106-
[back](README.md)

‎docs/021-defining-tasks.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ tags: [diego-release, bbs]
66

77
## Defining Tasks
88

9-
This document explains the fields available when defining a new Task. For a higher-level overview of the Diego Task API, see the [Tasks Overview](tasks.md).
9+
This document explains the fields available when defining a new Task. For a higher-level overview of the Diego Task API, see the [Tasks Overview](020-tasks.md).
1010

1111
```go
1212
client := bbs.NewClient(url)
@@ -155,23 +155,23 @@ Setting `ImagePassword` requires the `ImageUsername` to also be set.
155155

156156
##### `EnvironmentVariables` [optional]
157157

158-
See description of [Environment Variables](common-models.md#environmentvariables-optional)
158+
See description of [Environment Variables](054-common-models.md#environmentvariables-optional)
159159

160160
##### `CachedDependencies` [optional]
161161

162-
See description of [Cached Dependencies](common-models.md#cacheddependencies-optional)
162+
See description of [Cached Dependencies](054-common-models.md#cacheddependencies-optional)
163163

164164
##### `ImageLayers` [optional]
165165

166-
See description of [Image Layers](common-models.md#imagelayers-optional)
166+
See description of [Image Layers](054-common-models.md#imagelayers-optional)
167167

168168
##### `TrustedSystemCertificatesPath` [optional]
169169

170170
An absolute path inside the container's filesystem where trusted system certificates will be provided if an operator has specified them.
171171

172172
##### `VolumeMounts` [optional]
173173

174-
See description of [Volume Mounts](common-models.md#volumemounts-optional)
174+
See description of [Volume Mounts](054-common-models.md#volumemounts-optional)
175175

176176
##### `PlacementTags` [optional]
177177

@@ -225,7 +225,7 @@ A memory limit in mebibytes applied to the container. If the total memory consu
225225

226226
##### `Action` [required]
227227

228-
Encodes the action to execute when running the Task. For more details, see the section on [Actions](actions.md).
228+
Encodes the action to execute when running the Task. For more details, see the section on [Actions](053-actions.md).
229229

230230

231231
#### Task Completion and Output
@@ -258,7 +258,7 @@ By default network access for any container is limited but some tasks may need s
258258

259259
##### `EgressRules` [optional]
260260

261-
See description of [EgressRules](common-models.md#egressrules-optional)
261+
See description of [EgressRules](054-common-models.md#egressrules-optional)
262262

263263
---
264264

@@ -286,7 +286,3 @@ The `MetricsGuid` field sets the `ApplicationId` on container metris coming from
286286
##### `Annotation` [optional]
287287

288288
Diego allows arbitrary annotations to be attached to a Task. The annotation may not exceed 10 kilobytes in size.
289-
290-
291-
292-
[back](README.md)

‎docs/022-task-examples.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,5 +83,3 @@ if err != nil {
8383
log.Printf("failed to cancel task: " + err.Error())
8484
}
8585
```
86-
87-
[back](README.md)

‎docs/023-api-tasks.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -279,4 +279,3 @@ if err != nil {
279279
log.Printf("failed to delete task: " + err.Error())
280280
}
281281
```
282-
[back](README.md)

‎docs/024-api-tasks-internal.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ if shouldStart {
5555

5656
## FailTask
5757

58-
**Deprecated** in favor of [CompleteTask](api-tasks-internal.md#completetask) and [CancelTask](api-tasks.md#canceltask).
58+
**Deprecated** in favor of [CompleteTask](024-api-tasks-internal.md#completetask) and [CancelTask](023-api-tasks.md#canceltask).
5959

6060
### BBS API Endpoint
6161

@@ -155,5 +155,3 @@ if err != nil {
155155
log.Printf("could not complete task: " + err.Error())
156156
}
157157
```
158-
159-
[back](README.md)

‎docs/030-lrps.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ The fact that a DesiredLRP is present in Diego does not mean that the correspond
114114

115115
## Fetching ActualLRPs
116116

117-
As outlined above, DesiredLRPs represent the consumer's intent for Diego to run instances. To fetch instances, consumers must [fetch ActualLRPs](api-lrps.md#actuallrp-apis).
117+
As outlined above, DesiredLRPs represent the consumer's intent for Diego to run instances. To fetch instances, consumers must [fetch ActualLRPs](033-api-lrps.md#actuallrp-apis).
118118

119119
When fetching ActualLRPs, one can fetch *all* ActualLRPs in Diego, all ActualLRPs of a given `domain`, all ActualLRPs for a given DesiredLRP by `process_guid`, and all ActualLRPs at a given *index* for a given `process_guid`.
120120

@@ -216,7 +216,7 @@ Indicates if the ActualLRP can respond to traffic succesfully or not.
216216

217217
When an ActualLRP is first created, `routable` is set by default to `False`.
218218

219-
Once the ActualLRP is assigned to a cell, the container performs start up and parallel healthchecking processes, including optional [readiness checks as defined in the DesiredLRP](./defining-lrps.md).
219+
Once the ActualLRP is assigned to a cell, the container performs start up and parallel healthchecking processes, including optional [readiness checks as defined in the DesiredLRP](./031-defining-lrps.md).
220220

221221
After the readiness checks pass, or if there are no readiness checks defined at all, the ActualLRP `routable` field is tranistioned from `False` to `True`.
222222

@@ -240,7 +240,7 @@ The availability zone of the Diego cell where ActualLRP is running.
240240
241241
## Killing ActualLRPs
242242

243-
Diego supports killing the `ActualLRP`s for a given `process_guid` at a given `index`. This is documented [here](api-lrps.md#retireactuallrp). Note that this does not change the *desired* state -- Diego will simply shut down the `ActualLRP` at the given `index` and will eventually converge on desired state by restarting the (now-missing) instance. To permanently scale down a DesiredLRP you must update the `instances` field on the DesiredLRP.
243+
Diego supports killing the `ActualLRP`s for a given `process_guid` at a given `index`. This is documented [here](033-api-lrps.md#retireactuallrp). Note that this does not change the *desired* state -- Diego will simply shut down the `ActualLRP` at the given `index` and will eventually converge on desired state by restarting the (now-missing) instance. To permanently scale down a DesiredLRP you must update the `instances` field on the DesiredLRP.
244244

245245

246246
## Domain Freshness
@@ -251,10 +251,8 @@ In order to perform this responsibility safely, however, Diego must have some wa
251251

252252
To circumvent this, it is up to the consumer of Diego to inform Diego that its knowledge of the desired state is up-to-date. We refer to this as the "freshness" of the desired state. Consumers explicitly mark desired state as *fresh* on a domain-by-domain basis. Failing to do so will prevent Diego from taking actions to ensure eventual consistency (in particular, Diego will refuse to stop extra instances with no corresponding desired state).
253253

254-
To maintain freshness you perform a simple [POST](domains.md#upserting-a-domain). The consumer typically supplies a TTL and attempts to bump the freshness of the domain before the TTL expires (verifying along the way, of course, that the contents of Diego's DesiredLRP are up-to-date).
254+
To maintain freshness you perform a simple [POST](050-domains.md#upserting-a-domain). The consumer typically supplies a TTL and attempts to bump the freshness of the domain before the TTL expires (verifying along the way, of course, that the contents of Diego's DesiredLRP are up-to-date).
255255

256256
It is possible to opt out of this by updating the freshness with *no* TTL. In this case the freshness will never expire and Diego will always perform all its eventual consistency operations.
257257

258258
> Note: only destructive operations performed during an eventual consistency convergence cycle are gated on freshness. Diego will continue to start/stop instances when explicitly instructed to.
259-
260-
[back](README.md)

‎docs/031-defining-lrps.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ tags: [diego-release, bbs]
66

77
### Defining LRPs
88

9-
This document explains the fields available when defining a new LRP. For a higher-level overview of the Diego LRP API, see the [LRPs Overview](lrps.md).
9+
This document explains the fields available when defining a new LRP. For a higher-level overview of the Diego LRP API, see the [LRPs Overview](030-lrps.md).
1010

1111
```go
1212
client := bbs.NewClient(url)
@@ -141,7 +141,7 @@ refer to it by its `ProcessGuid`.
141141
- If you attempt to create a DesiredLRP with a `ProcessGuid` that matches that
142142
of an existing DesiredLRP, Diego will attempt to update the existing
143143
DesiredLRP. This is subject to the rules described in [updating
144-
DesiredLRPs](lrps.md#updating-desiredlrps) below.
144+
DesiredLRPs](030-lrps.md#updating-desiredlrps) below.
145145

146146

147147
##### `Domain` [required]
@@ -211,23 +211,23 @@ Setting `ImagePassword` requires the `ImageUsername` to also be set.
211211

212212
##### `EnvironmentVariables` [optional]
213213

214-
See description of [Environment Variables](common-models.md#environmentvariables-optional)
214+
See description of [Environment Variables](054-common-models.md#environmentvariables-optional)
215215

216216
##### `CachedDependencies` [optional]
217217

218-
See description of [Cached Dependencies](common-models.md#cacheddependencies-optional)
218+
See description of [Cached Dependencies](054-common-models.md#cacheddependencies-optional)
219219

220220
##### `ImageLayers` [optional]
221221

222-
See description of [Image Layers](common-models.md#imagelayers-optional)
222+
See description of [Image Layers](054-common-models.md#imagelayers-optional)
223223

224224
##### `TrustedSystemCertificatesPath` [optional]
225225

226226
An absolute path inside the container's filesystem where trusted system certificates will be provided if an operator has specified them.
227227

228228
##### `VolumeMounts` [optional]
229229

230-
See description of [Volume Mounts](common-models.md#volumemounts-optional)
230+
See description of [Volume Mounts](054-common-models.md#volumemounts-optional)
231231

232232
##### `PlacementTags` [optional]
233233

@@ -295,15 +295,15 @@ Diego is responsible for performing any container setup necessary to successfull
295295

296296
After creating a container, Diego will first run the action specified in the `Setup` field.
297297
This field is optional and is typically used to download files and run (short-lived) processes that configure the container.
298-
For more details on the available actions see [actions](actions.md).
298+
For more details on the available actions see [actions](053-actions.md).
299299

300300
- If the `Setup` action fails the `ActualLRP` is considered to have crashed and will be restarted
301301

302302
##### `Action` [required]
303303

304304
After completing any `Setup` action, Diego will launch the `Action` action.
305305
This `Action` is intended to launch any long-running processes.
306-
For more details on the available actions see [actions](actions.md).
306+
For more details on the available actions see [actions](053-actions.md).
307307

308308
##### `CheckDefinition` [optional]
309309

@@ -360,7 +360,7 @@ A TCP health check.
360360

361361
If provided, Diego will monitor the long running processes encoded in `Action` by periodically invoking the `Monitor` action.
362362
If the `Monitor` action returns succesfully (exit status code 0), the container is deemed "healthy", otherwise the container is deemed "unhealthy".
363-
Monitoring is quite flexible in Diego and is outlined in more detail [here](lrps.md#monitoring-health).
363+
Monitoring is quite flexible in Diego and is outlined in more detail [here](030-lrps.md#monitoring-health).
364364

365365
##### `StartTimeoutMs` [required]
366366

@@ -399,7 +399,7 @@ The total length of the routing information must not exceed 131072 bytes (128kb)
399399

400400
##### `EgressRules` [optional]
401401

402-
See description of [EgressRules](common-models.md#egressrules-optional)
402+
See description of [EgressRules](054-common-models.md#egressrules-optional)
403403

404404
#### Logging
405405

@@ -438,5 +438,3 @@ clients.
438438

439439
Diego allows arbitrary annotations to be attached to a DesiredLRP.
440440
The annotation must not exceed 10 kilobytes in size.
441-
442-
[back](README.md)

‎docs/032-lrp-examples.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -159,5 +159,3 @@ if err != nil {
159159
log.Printf("failed to remove desired lrp: " + err.Error())
160160
}
161161
```
162-
163-
[back](README.md)

‎docs/033-api-lrps.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -543,4 +543,3 @@ if err != nil {
543543
log.Printf("failed to remove desired lrp: " + err.Error())
544544
}
545545
```
546-
[back](README.md)

‎docs/034-api-lrps-internal.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -489,4 +489,3 @@ if err != nil {
489489
log.Printf("failed to remove evacuating actual lrp: " + err.Error())
490490
}
491491
```
492-
[back](README.md)

‎docs/041-revisioning-bbs-api-endpoints.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,5 +53,4 @@ based on when each was introduced:
5353
| | `/v1/desired_lrps/list.r3` (new) | | |
5454

5555
# See Also
56-
- To find more documentation about specific endpoints, look in the [table of contents](README.md) for links to API references.
57-
- To find information about endpoints that are deprecated (that is, still supported but planned to be removed in the next major release), look at [this document in diego-release](https://github.com/cloudfoundry/diego-release/blob/develop/docs/deprecations.md#bbs-1).
56+
- To find information about endpoints that are deprecated (that is, still supported but planned to be removed in the next major release), look at [this document in diego-release](https://github.com/cloudfoundry/diego-release/blob/develop/docs/081-deprecations.md#bbs-1).

‎docs/042-bbs-migration.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,4 +34,3 @@ This will create test and implementation files for your migration in
3434
`db/migrations`. Look for `TODO` comments in the test file to get started.
3535

3636
Note that the test file includes a test for migration idempotency.
37-

‎docs/050-domains.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,4 +116,3 @@ None.
116116
client := bbs.NewClient(url)
117117
domains, err := client.Domains(logger)
118118
```
119-
[back](README.md)

‎docs/051-environment.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ tags: [diego-release, bbs]
88
Diego provides several collections of environment variables to processes running in containers. These include the following layers, in order:
99

1010
- Environment variables baked into the Docker image (for Docker-image-based containers only)
11-
- Container-level environment variables (defined on the [`Task`](tasks.md) and [`DesiredLRP`](lrps.md) objects)
11+
- Container-level environment variables (defined on the [`Task`](020-tasks.md) and [`DesiredLRP`](030-lrps.md) objects)
1212
- Configuration environment variables (LRPs only, described below)
13-
- Process-level environment variables (defined on the [`RunAction`](actions.md#runaction) object)
13+
- Process-level environment variables (defined on the [`RunAction`](053-actions.md#runaction) object)
1414

1515
## Configuration-level Environment Variables
1616

@@ -27,8 +27,6 @@ LRPs have additional runtime properties that are exposed to processes in the con
2727
These environment variables are provided *only* if the operator deploying Diego has enabled `-exportNetworkEnvVars` on the Cell rep.
2828

2929
- `CF_INSTANCE_IP` provides the IP of the host running the container. This is the IP used to address the container from the outside.
30-
- `CF_INSTANCE_PORT` contains the host-side port corresponding to the *first* port in the `DesiredLRP` [`ports`](lrps.md#ports) array.
30+
- `CF_INSTANCE_PORT` contains the host-side port corresponding to the *first* port in the `DesiredLRP` [`ports`](030-lrps.md#ports) array.
3131
- `CF_INSTANCE_ADDR` is identical to `$CF_INSTANCE_IP:$CF_INSTANCE_PORT`.
32-
- `CF_INSTANCE_PORTS` contains a list of JSON objects of the form `[{"external":60413,"internal":8080},{"external":60414,"internal":2222}]`. The internal ports are the container-side ports specified in the `DesiredLRP` [`ports`](lrps.md#ports) array, and the external ports are the corresponding host-side ports.
33-
34-
[back](README.md)
32+
- `CF_INSTANCE_PORTS` contains a list of JSON objects of the form `[{"external":60413,"internal":8080},{"external":60414,"internal":2222}]`. The internal ports are the container-side ports specified in the `DesiredLRP` [`ports`](030-lrps.md#ports) array, and the external ports are the corresponding host-side ports.

‎docs/052-events.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -250,5 +250,3 @@ When a Task is deleted, a
250250
[TaskRemovedEvent](https://godoc.org/code.cloudfoundry.org/bbs/models#TaskRemovedEvent)
251251
is emitted. The field value of `Task` will have information about the
252252
Task that was just removed.
253-
254-
[back](README.md)

‎docs/053-actions.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ tags: [diego-release, bbs]
66

77
# Available Actions
88

9-
[Tasks](tasks.md) and [LRPs](lrps.md) express their work in terms of composable Actions. The following types of Action are available:
9+
[Tasks](020-tasks.md) and [LRPs](030-lrps.md) express their work in terms of composable Actions. The following types of Action are available:
1010

1111
- Basic Actions:
1212
- [`RunAction`](#runaction): Runs a process in the container.
@@ -356,6 +356,3 @@ The action to run.
356356

357357
If provided, logs emitted by this action and its subaction will be tagged with
358358
the provided `LogSource`. Otherwise the container-level `LogSource` is used.
359-
360-
361-
[back](README.md)

0 commit comments

Comments
 (0)