xref: /aosp_15_r20/external/googleapis/google/cloud/runtimeconfig/README.md (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9)
1*d5c09012SAndroid Build Coastguard Worker[TOC]
2*d5c09012SAndroid Build Coastguard Worker
3*d5c09012SAndroid Build Coastguard Worker# Introduction
4*d5c09012SAndroid Build Coastguard Worker
5*d5c09012SAndroid Build Coastguard WorkerThe RuntimeConfig service provides Google Cloud Platform users the ability to
6*d5c09012SAndroid Build Coastguard Workerdynamically configure your service.
7*d5c09012SAndroid Build Coastguard Worker
8*d5c09012SAndroid Build Coastguard WorkerThe RuntimConfig service creates and manages RuntimeConfig resources
9*d5c09012SAndroid Build Coastguard Workerwithin a Google Cloud Project and various variables within said resource.
10*d5c09012SAndroid Build Coastguard Worker
11*d5c09012SAndroid Build Coastguard Worker## Details
12*d5c09012SAndroid Build Coastguard Worker
13*d5c09012SAndroid Build Coastguard WorkerEach cloud project can create multiple **Config** objects. A **Config** object
14*d5c09012SAndroid Build Coastguard Workerby itself does not contain any configuration information, but rather is a
15*d5c09012SAndroid Build Coastguard Workerlogical grouping of variables. Variable names are hierarchical and follow file
16*d5c09012SAndroid Build Coastguard Workersystem style, where only leaf nodes can contain values.
17*d5c09012SAndroid Build Coastguard Worker
18*d5c09012SAndroid Build Coastguard WorkerFor example, you can have a configuration called *Flags*. Within that
19*d5c09012SAndroid Build Coastguard Workerconfiguration object, you can create the following variables.
20*d5c09012SAndroid Build Coastguard Worker
21*d5c09012SAndroid Build Coastguard Worker* `/ports/service_port`
22*d5c09012SAndroid Build Coastguard Worker* `/ports/monitoring_port`
23*d5c09012SAndroid Build Coastguard Worker* `/ports/admin_port`
24*d5c09012SAndroid Build Coastguard Worker
25*d5c09012SAndroid Build Coastguard WorkerThis creates three variables: `/ports/serve_port`, `/ports/monitoring_port`,
26*d5c09012SAndroid Build Coastguard Worker`/ports/admin_port`. Note that `/ports` cannot have a value but it can be
27*d5c09012SAndroid Build Coastguard Workerlisted.
28*d5c09012SAndroid Build Coastguard Worker
29*d5c09012SAndroid Build Coastguard Worker### Setup
30*d5c09012SAndroid Build Coastguard Worker
31*d5c09012SAndroid Build Coastguard WorkerIn order to make requests to RuntimeConfig service, you need to enable the API
32*d5c09012SAndroid Build Coastguard Workerfor your project.
33*d5c09012SAndroid Build Coastguard Worker
34*d5c09012SAndroid Build Coastguard WorkerTo achieve that, go to the
35*d5c09012SAndroid Build Coastguard Worker[Google Cloud Console](https://console.cloud.google.com/apis/api/runtimeconfig.googleapis.com/overview)
36*d5c09012SAndroid Build Coastguard Workerand enable *Google Cloud RuntimeConfig API* for your project.
37*d5c09012SAndroid Build Coastguard Worker
38*d5c09012SAndroid Build Coastguard WorkerThe documentation for this service is located
39*d5c09012SAndroid Build Coastguard Worker[here](https://cloud.google.com/deployment-manager/runtime-configurator/reference/rest/).
40