Skip to content
This repository was archived by the owner on Jun 2, 2021. It is now read-only.

Commit 2b2920f

Browse files
weymanfTeal Stannardmonamohebbi
committed
Add app start differences to the upgrade guide.
[#172094705] Co-authored-by: Weyman Fung <wfung@pivotal.io> Co-authored-by: Teal Stannard <tstannard@pivotal.io> Co-authored-by: Mona Mohebbi <mmohebbi@pivotal.io>
1 parent 92284f2 commit 2b2920f

3 files changed

Lines changed: 22 additions & 0 deletions

File tree

343 KB
Loading
417 KB
Loading

docs/v3/source/includes/upgrade_guide/upgrade_guide.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,28 @@ Here are some examples of implications for clients:
140140
2. An application can have multiple processes, each with their own start command, scale, and stats
141141
3. An application might not be running with its most recent package or droplet
142142

143+
#### Starting Apps
144+
145+
In the V2 API, the start endpoint (`PUT /v2/apps/:GUID` with `state`: `STARTED` in the request) was responsible for converting source code into a running executable in the cloud. In V3, [starting an app](#start-an-app) will only start the app processes with the current droplet.
146+
147+
To reproduce the V2 start behavior in V3:
148+
149+
![Start Diagram](start_diagram.png)
150+
151+
1. [List packages](#list-packages) and filter on package state with value `READY` and order by recency.
152+
1. If a package has been turned into a droplet [(see this endpoint)](#list-droplets-for-a-package) this means it has been staged already. In V2 workflows, this would mean this package is what the current droplet is running.
153+
1. Stage the package by [creating a build](#create-a-build). This turns your package into a droplet.
154+
1. Update the app’s [current droplet](#set-current-droplet) to the selected droplet. This droplet will be run when the app starts.
155+
1. Change the app’s state to [started](#start-an-app)
156+
157+
This gives V3 users more flexibility when managing applications. The following
158+
diagram shows many different flows for starting an app.
159+
160+
![Start Flow](start_flows.png)
161+
162+
Apps can upload multiple packages, stage multiple droplets, roll back to older droplets, and other complicated workflows.
163+
164+
143165
### Asynchronous Operations
144166

145167
Unlike V2, clients cannot opt-in for asynchronous responses from endpoints. Instead, endpoints that require asynchronous processing will return `202 Accepted` with a Location header pointing to the job resource to poll. Endpoints that do not require asynchronous processing will respond synchronously.

0 commit comments

Comments
 (0)