Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(376)

Side by Side Diff: appengine/swarming/doc/Magic-Values.md

Issue 2987333002: Refactor all gRPC proxy code into a single class. (Closed)
Patch Set: Fix pylint errors Created 3 years, 4 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« no previous file with comments | « no previous file | appengine/swarming/server/bot_archive.py » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 # Magic Values 1 # Magic Values
2 2
3 Describes magic values on the swarming server 3 Describes magic values on the swarming server
4 4
5 ## Introduction 5 ## Introduction
6 6
7 There are a few "magic" values in the isolate and swarming server. Also some 7 There are a few "magic" values in the isolate and swarming server. Also some
8 dimensions and state values have special meaning. 8 dimensions and state values have special meaning.
9 9
10 10
(...skipping 26 matching lines...) Expand all
37 When a Swarming bot is running a task, the following environment variables are 37 When a Swarming bot is running a task, the following environment variables are
38 always set: 38 always set:
39 39
40 - `SWARMING_HEADLESS=1` is always set. 40 - `SWARMING_HEADLESS=1` is always set.
41 - `SWARMING_BOT_ID` is set to the bot id. 41 - `SWARMING_BOT_ID` is set to the bot id.
42 - `SWARMING_TASK_ID` is set to the task id. 42 - `SWARMING_TASK_ID` is set to the task id.
43 43
44 The following environment variables may be set to alter bot behavior: 44 The following environment variables may be set to alter bot behavior:
45 45
46 - `SWARMING_EXTERNAL_BOT_SETUP=1` disables bot_config.setup_bot hook. 46 - `SWARMING_EXTERNAL_BOT_SETUP=1` disables bot_config.setup_bot hook.
47 - `SWARMING_GRPC_PROXY=<url>` and `ISOLATED_GRPC_PROXY=<url>` override the
48 equivalent value in the bot config.
49 - `LUCI_GRPC_PROXY_VERBOSE` dumps out additional gRPC proxy information if set
50 to a truthy value (e.g. `1`).
51 - `LUCI_GRPC_PROXY_TLS_ROOTS=<file>` and points to a .crt file containing
52 certificate authorities. `LUCI_GRPC_PROXY_TLS_OVERRIDE=<name>` specifies the
53 name of the server in the certificate. These are useful for testing a gRPC
54 proxy running on localhost but with TLS enabled. Unlike the `*_GRPC_PROXY`
55 env vars, these are shared between Swarming and Isolated since they're only
56 used in the limited case when you need to override TLS. See
57 [/client/utils/grpc_proxy.py](../../../client/utils/grpc_proxy.py) for more
58 information.
47 59
48 60
49 ### dimensions 61 ### dimensions
50 62
51 - `id`: must be a single value in the list, which also must be unique. It's 63 - `id`: must be a single value in the list, which also must be unique. It's
52 what uniquely identify the bot. 64 what uniquely identify the bot.
53 - `quarantined`: if present, it specifies the bot self-quarantined, as it 65 - `quarantined`: if present, it specifies the bot self-quarantined, as it
54 found out it needs manual sysadmin assistance before being able to accept 66 found out it needs manual sysadmin assistance before being able to accept
55 any task. An example is that it doesn't enough free disk space. 67 any task. An example is that it doesn't enough free disk space.
56 68
(...skipping 15 matching lines...) Expand all
72 handshake. The server will ask the bot to restart if this configuration 84 handshake. The server will ask the bot to restart if this configuration
73 changes. 85 changes.
74 86
75 ### tags 87 ### tags
76 88
77 - `source_revision`: if present, it specifies the SCM revision related to the 89 - `source_revision`: if present, it specifies the SCM revision related to the
78 task. This allows the UI to link to the relevant revision. 90 task. This allows the UI to link to the relevant revision.
79 - `source_repo`: if present, it is a url to the hosted SCM related to the 91 - `source_repo`: if present, it is a url to the hosted SCM related to the
80 task, with a %s where the revision should be placed. This allows the UI 92 task, with a %s where the revision should be placed. This allows the UI
81 to link to the relevant revision. 93 to link to the relevant revision.
OLDNEW
« no previous file with comments | « no previous file | appengine/swarming/server/bot_archive.py » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698