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