···

       
123
       
 
       
            '';

     

       
124
       
 
       


     

       
125
       
 
       
            credentials = mkOpt types.str ''

     

       
126
       
-
       
              Sets the credentials. It is mutually exclusive with `credentials_file`.

     

       
127
       
 
       
            '';

     

       
128
       
 
       


     

       
129
       
 
       
            credentials_file = mkOpt types.str ''

     

       
130
       
 
       
              Sets the credentials to the credentials read from the configured file.

     

       
131
       
-
       
              It is mutually exclusive with `credentials`.

     

       
132
       
 
       
            '';

     

       
133
       
 
       
          };

     

       
134
       
 
       
        }) ''

     

       
135
       
-
       
        Optional `Authorization` header configuration.

     

       
136
       
 
       
      '';

     

       
137
       
 
       


     

       
138
       
 
       
      oauth2 = mkOpt promtypes.oauth2 ''

     
···

       
229
       
 
       
      '';

     

       
230
       
 
       


     

       
231
       
 
       
      client_secret_file = mkOpt types.str ''

     

       
232
       
-
       
        Read the client secret from a file. It is mutually exclusive with `client_secret`.

     

       
233
       
 
       
      '';

     

       
234
       
 
       


     

       
235
       
 
       
      scopes = mkOpt (types.listOf types.str) ''

     
···

       
315
       
 
       
      '';

     

       
316
       
 
       


     

       
317
       
 
       
      basic_auth = mkOpt promTypes.basic_auth ''

     

       
318
       
-
       
        Sets the `Authorization` header on every scrape request with the

     

       
319
       
 
       
        configured username and password.

     

       
320
       
 
       
        password and password_file are mutually exclusive.

     

       
321
       
 
       
      '';

     

       
322
       
 
       


     

       
323
       
 
       
      bearer_token = mkOpt types.str ''

     

       
324
       
-
       
        Sets the `Authorization` header on every scrape request with

     

       
325
       
 
       
        the configured bearer token. It is mutually exclusive with

     

       
326
       
 
       
        <option>bearer_token_file</option>.

     

       
327
       
 
       
      '';

     

       
328
       
 
       


     

       
329
       
 
       
      bearer_token_file = mkOpt types.str ''

     

       
330
       
-
       
        Sets the `Authorization` header on every scrape request with

     

       
331
       
 
       
        the bearer token read from the configured file. It is mutually

     

       
332
       
 
       
        exclusive with <option>bearer_token</option>.

     

       
333
       
 
       
      '';

     
···

       
623
       
 
       
    };

     

       
624
       
 
       


     

       
625
       
 
       
    port = mkDefOpt types.int "80" ''

     

       
626
       
-
       
      The port to scrape metrics from, when `role` is nodes, and for discovered

     

       
627
       
 
       
      tasks and services that don't have published ports.

     

       
628
       
 
       
    '';

     

       
629
       
 
       


     
···

       
1205
       
 
       


     

       
1206
       
 
       
      secret_key = mkOpt types.str ''

     

       
1207
       
 
       
        Secret key to use when listing targets. https://console.scaleway.com/project/credentials

     

       
1208
       
-
       
        It is mutually exclusive with `secret_key_file`.

     

       
1209
       
 
       
      '';

     

       
1210
       
 
       


     

       
1211
       
 
       
      secret_key_file = mkOpt types.str ''

     

       
1212
       
 
       
        Sets the secret key with the credentials read from the configured file.

     

       
1213
       
-
       
        It is mutually exclusive with `secret_key`.

     

       
1214
       
 
       
      '';

     

       
1215
       
 
       


     

       
1216
       
 
       
      project_id = mkOption {

     
···

       
1440
       
 
       
        remote write configs.

     

       
1441
       
 
       
      '';

     

       
1442
       
 
       
      basic_auth = mkOpt promTypes.basic_auth ''

     

       
1443
       
-
       
        Sets the `Authorization` header on every remote write request with the

     

       
1444
       
 
       
        configured username and password.

     

       
1445
       
 
       
        password and password_file are mutually exclusive.

     

       
1446
       
 
       
      '';

     

       
1447
       
 
       
      bearer_token = mkOpt types.str ''

     

       
1448
       
-
       
        Sets the `Authorization` header on every remote write request with

     

       
1449
       
-
       
        the configured bearer token. It is mutually exclusive with `bearer_token_file`.

     

       
1450
       
 
       
      '';

     

       
1451
       
 
       
      bearer_token_file = mkOpt types.str ''

     

       
1452
       
-
       
        Sets the `Authorization` header on every remote write request with the bearer token

     

       
1453
       
-
       
        read from the configured file. It is mutually exclusive with `bearer_token`.

     

       
1454
       
 
       
      '';

     

       
1455
       
 
       
      tls_config = mkOpt promTypes.tls_config ''

     

       
1456
       
 
       
        Configures the remote write request's TLS settings.

     
···

       
1531
       
 
       
        the local storage should have complete data for.

     

       
1532
       
 
       
      '';

     

       
1533
       
 
       
      basic_auth = mkOpt promTypes.basic_auth ''

     

       
1534
       
-
       
        Sets the `Authorization` header on every remote read request with the

     

       
1535
       
 
       
        configured username and password.

     

       
1536
       
 
       
        password and password_file are mutually exclusive.

     

       
1537
       
 
       
      '';

     

       
1538
       
 
       
      bearer_token = mkOpt types.str ''

     

       
1539
       
-
       
        Sets the `Authorization` header on every remote read request with

     

       
1540
       
-
       
        the configured bearer token. It is mutually exclusive with `bearer_token_file`.

     

       
1541
       
 
       
      '';

     

       
1542
       
 
       
      bearer_token_file = mkOpt types.str ''

     

       
1543
       
-
       
        Sets the `Authorization` header on every remote read request with the bearer token

     

       
1544
       
-
       
        read from the configured file. It is mutually exclusive with `bearer_token`.

     

       
1545
       
 
       
      '';

     

       
1546
       
 
       
      tls_config = mkOpt promTypes.tls_config ''

     

       
1547
       
 
       
        Configures the remote read request's TLS settings.

     

···

       
123
       
 
       
            '';

     

       
124
       
 
       


     

       
125
       
 
       
            credentials = mkOpt types.str ''

     

       
126
       
+
       
              Sets the credentials. It is mutually exclusive with <literal>credentials_file</literal>.

     

       
127
       
 
       
            '';

     

       
128
       
 
       


     

       
129
       
 
       
            credentials_file = mkOpt types.str ''

     

       
130
       
 
       
              Sets the credentials to the credentials read from the configured file.

     

       
131
       
+
       
              It is mutually exclusive with <literal>credentials</literal>.

     

       
132
       
 
       
            '';

     

       
133
       
 
       
          };

     

       
134
       
 
       
        }) ''

     

       
135
       
+
       
        Optional <literal>Authorization</literal> header configuration.

     

       
136
       
 
       
      '';

     

       
137
       
 
       


     

       
138
       
 
       
      oauth2 = mkOpt promtypes.oauth2 ''

     
···

       
229
       
 
       
      '';

     

       
230
       
 
       


     

       
231
       
 
       
      client_secret_file = mkOpt types.str ''

     

       
232
       
+
       
        Read the client secret from a file. It is mutually exclusive with <literal>client_secret</literal>.

     

       
233
       
 
       
      '';

     

       
234
       
 
       


     

       
235
       
 
       
      scopes = mkOpt (types.listOf types.str) ''

     
···

       
315
       
 
       
      '';

     

       
316
       
 
       


     

       
317
       
 
       
      basic_auth = mkOpt promTypes.basic_auth ''

     

       
318
       
+
       
        Sets the <literal>Authorization</literal> header on every scrape request with the

     

       
319
       
 
       
        configured username and password.

     

       
320
       
 
       
        password and password_file are mutually exclusive.

     

       
321
       
 
       
      '';

     

       
322
       
 
       


     

       
323
       
 
       
      bearer_token = mkOpt types.str ''

     

       
324
       
+
       
        Sets the <literal>Authorization</literal> header on every scrape request with

     

       
325
       
 
       
        the configured bearer token. It is mutually exclusive with

     

       
326
       
 
       
        <option>bearer_token_file</option>.

     

       
327
       
 
       
      '';

     

       
328
       
 
       


     

       
329
       
 
       
      bearer_token_file = mkOpt types.str ''

     

       
330
       
+
       
        Sets the <literal>Authorization</literal> header on every scrape request with

     

       
331
       
 
       
        the bearer token read from the configured file. It is mutually

     

       
332
       
 
       
        exclusive with <option>bearer_token</option>.

     

       
333
       
 
       
      '';

     
···

       
623
       
 
       
    };

     

       
624
       
 
       


     

       
625
       
 
       
    port = mkDefOpt types.int "80" ''

     

       
626
       
+
       
      The port to scrape metrics from, when <literal>role</literal> is nodes, and for discovered

     

       
627
       
 
       
      tasks and services that don't have published ports.

     

       
628
       
 
       
    '';

     

       
629
       
 
       


     
···

       
1205
       
 
       


     

       
1206
       
 
       
      secret_key = mkOpt types.str ''

     

       
1207
       
 
       
        Secret key to use when listing targets. https://console.scaleway.com/project/credentials

     

       
1208
       
+
       
        It is mutually exclusive with <literal>secret_key_file</literal>.

     

       
1209
       
 
       
      '';

     

       
1210
       
 
       


     

       
1211
       
 
       
      secret_key_file = mkOpt types.str ''

     

       
1212
       
 
       
        Sets the secret key with the credentials read from the configured file.

     

       
1213
       
+
       
        It is mutually exclusive with <literal>secret_key</literal>.

     

       
1214
       
 
       
      '';

     

       
1215
       
 
       


     

       
1216
       
 
       
      project_id = mkOption {

     
···

       
1440
       
 
       
        remote write configs.

     

       
1441
       
 
       
      '';

     

       
1442
       
 
       
      basic_auth = mkOpt promTypes.basic_auth ''

     

       
1443
       
+
       
        Sets the <literal>Authorization</literal> header on every remote write request with the

     

       
1444
       
 
       
        configured username and password.

     

       
1445
       
 
       
        password and password_file are mutually exclusive.

     

       
1446
       
 
       
      '';

     

       
1447
       
 
       
      bearer_token = mkOpt types.str ''

     

       
1448
       
+
       
        Sets the <literal>Authorization</literal> header on every remote write request with

     

       
1449
       
+
       
        the configured bearer token. It is mutually exclusive with <literal>bearer_token_file</literal>.

     

       
1450
       
 
       
      '';

     

       
1451
       
 
       
      bearer_token_file = mkOpt types.str ''

     

       
1452
       
+
       
        Sets the <literal>Authorization</literal> header on every remote write request with the bearer token

     

       
1453
       
+
       
        read from the configured file. It is mutually exclusive with <literal>bearer_token</literal>.

     

       
1454
       
 
       
      '';

     

       
1455
       
 
       
      tls_config = mkOpt promTypes.tls_config ''

     

       
1456
       
 
       
        Configures the remote write request's TLS settings.

     
···

       
1531
       
 
       
        the local storage should have complete data for.

     

       
1532
       
 
       
      '';

     

       
1533
       
 
       
      basic_auth = mkOpt promTypes.basic_auth ''

     

       
1534
       
+
       
        Sets the <literal>Authorization</literal> header on every remote read request with the

     

       
1535
       
 
       
        configured username and password.

     

       
1536
       
 
       
        password and password_file are mutually exclusive.

     

       
1537
       
 
       
      '';

     

       
1538
       
 
       
      bearer_token = mkOpt types.str ''

     

       
1539
       
+
       
        Sets the <literal>Authorization</literal> header on every remote read request with

     

       
1540
       
+
       
        the configured bearer token. It is mutually exclusive with <literal>bearer_token_file</literal>.

     

       
1541
       
 
       
      '';

     

       
1542
       
 
       
      bearer_token_file = mkOpt types.str ''

     

       
1543
       
+
       
        Sets the <literal>Authorization</literal> header on every remote read request with the bearer token

     

       
1544
       
+
       
        read from the configured file. It is mutually exclusive with <literal>bearer_token</literal>.

     

       
1545
       
 
       
      '';

     

       
1546
       
 
       
      tls_config = mkOpt promTypes.tls_config ''

     

       
1547
       
 
       
        Configures the remote read request's TLS settings.