Skip to content

Commit e546562

Browse files
docs: remove cfr references (#234)
1 parent 318a504 commit e546562

File tree

5 files changed

+16
-20
lines changed

5 files changed

+16
-20
lines changed

README.md

-1
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,6 @@ see [LICENSE](LICENSE) for details.
7171
The application is subject the following terms of use:
7272
- [Google Cloud Terms of Use](https://cloud.google.com/terms)
7373
- [Google Maps Platform Terms of Use](https://cloud.google.com/maps-platform/terms)
74-
- [Google Cloud Optimization API service-specific terms](https://cloud.google.com/optimization/docs/tos/service-terms)
7574
- [Google OAuth 2.0 Policies](https://developers.google.com/identity/protocols/oauth2/policies)
7675

7776

application/frontend/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Google Fleet Routing App - Frontend
22

33
Angular app providing a user interface to define
4-
Cloud Fleet Routing requests and visualize responses.
4+
Route Optimization requests and visualize responses.
55

66
## Dependencies
77
See [architecture documentation](../../docs/architecture.md)

docs/architecture.md

+13-16
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ The application consists of a **frontend** Angular single-page web application
44
and a Node.js **backend** API. The frontend app is served
55
as static files by the backend.
66

7-
Requests to **Cloud Fleet Routing** are proxied from the frontend
7+
Requests to **Route Optimization** are proxied from the frontend
88
through the backend. The backend forwards requests to the
9-
**Google Cloud Optimization client library for Node.js** (pre-release build),
9+
**Route Optimization client library for Node.js**,
1010
authenticated as the backend's dedicated service account.
1111

1212
Optionally, "scenario" and "solution" JSON files created in the app
@@ -17,7 +17,7 @@ This GCS integration must be explicitly enabled in the deployment configuration,
1717
```mermaid
1818
flowchart LR
1919
F[Angular Frontend] --- B["Node.js Backend (Cloud Run)"]
20-
B --- C["Cloud Fleet Routing (Cloud Optimization API)"]
20+
B --- C["Route Optimization (Route Optimization API)"]
2121
B -.- S[Google Cloud Storage]
2222
```
2323

@@ -35,7 +35,7 @@ Container images are pulled from an **Artifact Registry**
3535
repository in the `fleetrouting-app-ops` project.
3636

3737
The Cloud Run service runs as a dedicated **Service Account** (`fleetrouting-app`)
38-
with the *Cloud Optimization AI Editor* (`roles/cloudoptimization.editor`) IAM role.
38+
with the *Route Optimization Editor* (`roles/routeoptimization.editor`) IAM role.
3939
The Cloud Run instances run on a **private VPC network** (i.e. not publicly-accessible).
4040
*No default VPCs or service accounts are utilized*.
4141

@@ -87,9 +87,8 @@ are enabled for the project:
8787
- Secret Manager
8888
- Serverless VPC Access
8989
- Storage
90-
- Optimization / Fleet Routing
91-
- Cloud Optimization API
92-
- Maps for Fleet Routing
90+
- Optimization
91+
- Route Optimization API
9392
- Google Maps
9493
- Distance Matrix API
9594
- Geocoding API
@@ -101,7 +100,7 @@ are enabled for the project:
101100
## Frontend
102101
The frontend is an Angular single-page application (SPA).
103102

104-
- The user constructs a Cloud Fleet Routing vehicle routing *scenario*
103+
- The user constructs a Route Optimization vehicle routing *scenario*
105104
from scratch with the forms in the application
106105
or imports a JSON or CSV file populated with *scenario* data.
107106
- In the app forms, vehicle and shipment locations are specified
@@ -114,7 +113,7 @@ The frontend is an Angular single-page application (SPA).
114113
- Vehicle start/end locations
115114
- Shipment pickup/dropoff locations
116115
- The *scenario* can exported to local disk as a JSON file
117-
- When the user is ready, the app sends the *scenario* to **Cloud Fleet Routing**
116+
- When the user is ready, the app sends the *scenario* to **Route Optimization**
118117
via the **backend**, which returns a *solution* containing the optimized routes
119118
- Any errors for the request are presented to the user
120119
- With an active *solution*, users can explore the optimized routes
@@ -133,8 +132,8 @@ The backend service is a **Node.js Express API**, written in **TypeScript**.
133132
- Serves the frontend app as static content
134133
- Injects environment-specific variables (URLs, Maps API key, feature flags)
135134
into the frontend's `config.json` file at runtime
136-
- Proxies **Cloud Fleet Routing** requests, forwarding them to the
137-
**Google Cloud Optimization client library**
135+
- Proxies **Route Optimization** requests, forwarding them to the
136+
**Route Optimization client library**
138137
- If configured, writes and reads *scenario* and *solution* JSON files
139138
to/from Google Cloud Storage with the Google Cloud Storage client library
140139
- Requests have 1-hour to allow for long-running optimization requests
@@ -155,7 +154,7 @@ Runtime:
155154
- Angular
156155
- Deck.gl
157156
- Google Maps JavaScript API
158-
- Google Cloud Optimization client (pre-release)
157+
- Google Maps Route Optimization Client
159158
- NgRx
160159
- Turf
161160

@@ -170,9 +169,7 @@ Development:
170169
### Backend
171170
Runtime:
172171
- Express
173-
- Google Cloud Optimization Client
174-
> The optimization client library is an pre-release build provided by Google.
175-
> It is not publicly distributed.
172+
- Google Maps Route Optimization Client
176173
- Google Cloud Storage Client
177174
- Pino
178175

@@ -191,11 +188,11 @@ Development:
191188
## External APIs
192189
The following external APIs are used by the app:
193190

194-
- Google Cloud Optimization API
195191
- Google Fonts
196192
- Google Maps Platform:
197193
- Geocoding API
198194
- Maps JavaScript API
199195
- Places API
200196
- Static Maps API
197+
- Route Optimization API
201198
- Google Cloud Storage API

docs/deployment.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ the HTTPS certificate finishes provisioning.
140140

141141
The application is live when you see a **Google Sign-In** page upon loading the URL.
142142
After signing in, you should see the app's landing page
143-
with "Cloud Fleet Routing API" displayed at the top.
143+
with "Google Maps Platform | Route Optimization API" displayed at the top.
144144

145145
---
146146
### Troubleshooting

docs/project.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ gcloud projects create {PROJECT_ID} --name={PROJECT_NAME} --folder={FOLDER_NUMBE
4545
> Later, **Terraform** will explicitly enable just the services required by Fleet Routing App.
4646
4747
### Enable Billing
48-
**Cloud Fleet Routing** and **Google Maps Platform** and dependencies of
48+
**Route Optimization** and **Google Maps Platform** and dependencies of
4949
**Fleet Routing App** are paid services that require a project
5050
to be linked to a billing account before they can be enabled.
5151

0 commit comments

Comments
 (0)