@muhlba91/pulumi-proxmoxve
Version:
A Pulumi package for creating and managing Proxmox Virtual Environment cloud resources.
393 lines • 16.3 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* > **Deprecated:** Use `proxmoxve.metrics.Server` instead. This resource will be removed in v1.0.
*
* Manages PVE metrics server.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as proxmoxve from "@muhlba91/pulumi-proxmoxve";
*
* const influxdbServer = new proxmoxve.metrics.ServerLegacy("influxdb_server", {
* name: "example_influxdb_server",
* server: "192.168.3.2",
* port: 8089,
* type: "influxdb",
* });
* const graphiteServer = new proxmoxve.metrics.ServerLegacy("graphite_server", {
* name: "example_graphite_server",
* server: "192.168.4.2",
* port: 2003,
* type: "graphite",
* });
* const opentelemetryServer = new proxmoxve.metrics.ServerLegacy("opentelemetry_server", {
* name: "example_opentelemetry_server",
* server: "192.168.5.2",
* port: 4318,
* type: "opentelemetry",
* opentelemetryProto: "http",
* opentelemetryPath: "/v1/metrics",
* });
* ```
*
* ## Import
*
* !/usr/bin/env sh
*
* ```sh
* $ pulumi import proxmoxve:metrics/serverLegacy:ServerLegacy example example
* ```
*/
export declare class ServerLegacy extends pulumi.CustomResource {
/**
* Get an existing ServerLegacy resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ServerLegacyState, opts?: pulumi.CustomResourceOptions): ServerLegacy;
/**
* Returns true if the given object is an instance of ServerLegacy. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is ServerLegacy;
/**
* Set this to `true` to disable this metric server. Defaults to `false`.
*/
readonly disable: pulumi.Output<boolean>;
/**
* Root graphite path (ex: `proxmox.mycluster.mykey`).
*/
readonly graphitePath: pulumi.Output<string | undefined>;
/**
* Protocol to send graphite data. Choice is between `udp` | `tcp`. If not set, PVE default is `udp`.
*/
readonly graphiteProto: pulumi.Output<string | undefined>;
/**
* An API path prefix inserted between `<host>:<port>/` and `/api2/`. Can be useful if the InfluxDB service runs behind a reverse proxy.
*/
readonly influxApiPathPrefix: pulumi.Output<string | undefined>;
/**
* The InfluxDB bucket/db. Only necessary when using the http v2 api.
*/
readonly influxBucket: pulumi.Output<string | undefined>;
/**
* Protocol for InfluxDB. Choice is between `udp` | `http` | `https`. If not set, PVE default is `udp`.
*/
readonly influxDbProto: pulumi.Output<string | undefined>;
/**
* InfluxDB max-body-size in bytes. Requests are batched up to this size. If not set, PVE default is `25000000`.
*/
readonly influxMaxBodySize: pulumi.Output<number | undefined>;
/**
* The InfluxDB organization. Only necessary when using the http v2 api. Has no meaning when using v2 compatibility api.
*/
readonly influxOrganization: pulumi.Output<string | undefined>;
/**
* The InfluxDB access token. Only necessary when using the http v2 api. If the v2 compatibility api is used, use `user:password` instead. Cannot be used together with `influxTokenWo`.
*/
readonly influxToken: pulumi.Output<string | undefined>;
/**
* **NOTE:** This field is write-only and its value will not be updated in state as part of read operations.
* The InfluxDB access token (write-only). Prefer this over `influxToken` to avoid storing the secret in Terraform state. Cannot be used together with `influxToken`.
*/
readonly influxTokenWo: pulumi.Output<string | undefined>;
/**
* Increment this counter to rotate `influxTokenWo` without changing other fields.
*/
readonly influxTokenWoVersion: pulumi.Output<number | undefined>;
/**
* Set to `false` to disable certificate verification for https endpoints. If not set, PVE default is `true`.
*/
readonly influxVerify: pulumi.Output<boolean | undefined>;
/**
* MTU (maximum transmission unit) for metrics transmission over UDP. If not set, PVE default is `1500` (allowed `512` - `65536`).
*/
readonly mtu: pulumi.Output<number | undefined>;
/**
* Unique name that will be ID of this metric server in PVE.
*/
readonly name: pulumi.Output<string>;
/**
* OpenTelemetry compression algorithm for requests. Choice is between `none` | `gzip`. If not set, PVE default is `gzip`.
*/
readonly opentelemetryCompression: pulumi.Output<string | undefined>;
/**
* OpenTelemetry custom HTTP headers as JSON, base64 encoded.
*/
readonly opentelemetryHeaders: pulumi.Output<string | undefined>;
/**
* OpenTelemetry maximum request body size in bytes. If not set, PVE default is `10000000`.
*/
readonly opentelemetryMaxBodySize: pulumi.Output<number | undefined>;
/**
* OpenTelemetry endpoint path (e.g., `/v1/metrics`).
*/
readonly opentelemetryPath: pulumi.Output<string | undefined>;
/**
* Protocol for OpenTelemetry. Choice is between `http` | `https`. If not set, PVE default is `https`.
*/
readonly opentelemetryProto: pulumi.Output<string | undefined>;
/**
* OpenTelemetry additional resource attributes as JSON, base64 encoded.
*/
readonly opentelemetryResourceAttributes: pulumi.Output<string | undefined>;
/**
* OpenTelemetry HTTP request timeout in seconds. If not set, PVE default is `5`.
*/
readonly opentelemetryTimeout: pulumi.Output<number | undefined>;
/**
* OpenTelemetry verify SSL certificates. If not set, PVE default is `true`.
*/
readonly opentelemetryVerifySsl: pulumi.Output<boolean | undefined>;
/**
* Server network port.
*/
readonly port: pulumi.Output<number>;
/**
* Server dns name or IP address.
*/
readonly server: pulumi.Output<string>;
/**
* TCP socket timeout in seconds. If not set, PVE default is `1`.
*/
readonly timeout: pulumi.Output<number | undefined>;
/**
* Plugin type. Choice is between `graphite` | `influxdb` | `opentelemetry`.
*/
readonly type: pulumi.Output<string>;
/**
* Create a ServerLegacy resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: ServerLegacyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ServerLegacy resources.
*/
export interface ServerLegacyState {
/**
* Set this to `true` to disable this metric server. Defaults to `false`.
*/
disable?: pulumi.Input<boolean | undefined>;
/**
* Root graphite path (ex: `proxmox.mycluster.mykey`).
*/
graphitePath?: pulumi.Input<string | undefined>;
/**
* Protocol to send graphite data. Choice is between `udp` | `tcp`. If not set, PVE default is `udp`.
*/
graphiteProto?: pulumi.Input<string | undefined>;
/**
* An API path prefix inserted between `<host>:<port>/` and `/api2/`. Can be useful if the InfluxDB service runs behind a reverse proxy.
*/
influxApiPathPrefix?: pulumi.Input<string | undefined>;
/**
* The InfluxDB bucket/db. Only necessary when using the http v2 api.
*/
influxBucket?: pulumi.Input<string | undefined>;
/**
* Protocol for InfluxDB. Choice is between `udp` | `http` | `https`. If not set, PVE default is `udp`.
*/
influxDbProto?: pulumi.Input<string | undefined>;
/**
* InfluxDB max-body-size in bytes. Requests are batched up to this size. If not set, PVE default is `25000000`.
*/
influxMaxBodySize?: pulumi.Input<number | undefined>;
/**
* The InfluxDB organization. Only necessary when using the http v2 api. Has no meaning when using v2 compatibility api.
*/
influxOrganization?: pulumi.Input<string | undefined>;
/**
* The InfluxDB access token. Only necessary when using the http v2 api. If the v2 compatibility api is used, use `user:password` instead. Cannot be used together with `influxTokenWo`.
*/
influxToken?: pulumi.Input<string | undefined>;
/**
* **NOTE:** This field is write-only and its value will not be updated in state as part of read operations.
* The InfluxDB access token (write-only). Prefer this over `influxToken` to avoid storing the secret in Terraform state. Cannot be used together with `influxToken`.
*/
influxTokenWo?: pulumi.Input<string | undefined>;
/**
* Increment this counter to rotate `influxTokenWo` without changing other fields.
*/
influxTokenWoVersion?: pulumi.Input<number | undefined>;
/**
* Set to `false` to disable certificate verification for https endpoints. If not set, PVE default is `true`.
*/
influxVerify?: pulumi.Input<boolean | undefined>;
/**
* MTU (maximum transmission unit) for metrics transmission over UDP. If not set, PVE default is `1500` (allowed `512` - `65536`).
*/
mtu?: pulumi.Input<number | undefined>;
/**
* Unique name that will be ID of this metric server in PVE.
*/
name?: pulumi.Input<string | undefined>;
/**
* OpenTelemetry compression algorithm for requests. Choice is between `none` | `gzip`. If not set, PVE default is `gzip`.
*/
opentelemetryCompression?: pulumi.Input<string | undefined>;
/**
* OpenTelemetry custom HTTP headers as JSON, base64 encoded.
*/
opentelemetryHeaders?: pulumi.Input<string | undefined>;
/**
* OpenTelemetry maximum request body size in bytes. If not set, PVE default is `10000000`.
*/
opentelemetryMaxBodySize?: pulumi.Input<number | undefined>;
/**
* OpenTelemetry endpoint path (e.g., `/v1/metrics`).
*/
opentelemetryPath?: pulumi.Input<string | undefined>;
/**
* Protocol for OpenTelemetry. Choice is between `http` | `https`. If not set, PVE default is `https`.
*/
opentelemetryProto?: pulumi.Input<string | undefined>;
/**
* OpenTelemetry additional resource attributes as JSON, base64 encoded.
*/
opentelemetryResourceAttributes?: pulumi.Input<string | undefined>;
/**
* OpenTelemetry HTTP request timeout in seconds. If not set, PVE default is `5`.
*/
opentelemetryTimeout?: pulumi.Input<number | undefined>;
/**
* OpenTelemetry verify SSL certificates. If not set, PVE default is `true`.
*/
opentelemetryVerifySsl?: pulumi.Input<boolean | undefined>;
/**
* Server network port.
*/
port?: pulumi.Input<number | undefined>;
/**
* Server dns name or IP address.
*/
server?: pulumi.Input<string | undefined>;
/**
* TCP socket timeout in seconds. If not set, PVE default is `1`.
*/
timeout?: pulumi.Input<number | undefined>;
/**
* Plugin type. Choice is between `graphite` | `influxdb` | `opentelemetry`.
*/
type?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a ServerLegacy resource.
*/
export interface ServerLegacyArgs {
/**
* Set this to `true` to disable this metric server. Defaults to `false`.
*/
disable?: pulumi.Input<boolean | undefined>;
/**
* Root graphite path (ex: `proxmox.mycluster.mykey`).
*/
graphitePath?: pulumi.Input<string | undefined>;
/**
* Protocol to send graphite data. Choice is between `udp` | `tcp`. If not set, PVE default is `udp`.
*/
graphiteProto?: pulumi.Input<string | undefined>;
/**
* An API path prefix inserted between `<host>:<port>/` and `/api2/`. Can be useful if the InfluxDB service runs behind a reverse proxy.
*/
influxApiPathPrefix?: pulumi.Input<string | undefined>;
/**
* The InfluxDB bucket/db. Only necessary when using the http v2 api.
*/
influxBucket?: pulumi.Input<string | undefined>;
/**
* Protocol for InfluxDB. Choice is between `udp` | `http` | `https`. If not set, PVE default is `udp`.
*/
influxDbProto?: pulumi.Input<string | undefined>;
/**
* InfluxDB max-body-size in bytes. Requests are batched up to this size. If not set, PVE default is `25000000`.
*/
influxMaxBodySize?: pulumi.Input<number | undefined>;
/**
* The InfluxDB organization. Only necessary when using the http v2 api. Has no meaning when using v2 compatibility api.
*/
influxOrganization?: pulumi.Input<string | undefined>;
/**
* The InfluxDB access token. Only necessary when using the http v2 api. If the v2 compatibility api is used, use `user:password` instead. Cannot be used together with `influxTokenWo`.
*/
influxToken?: pulumi.Input<string | undefined>;
/**
* **NOTE:** This field is write-only and its value will not be updated in state as part of read operations.
* The InfluxDB access token (write-only). Prefer this over `influxToken` to avoid storing the secret in Terraform state. Cannot be used together with `influxToken`.
*/
influxTokenWo?: pulumi.Input<string | undefined>;
/**
* Increment this counter to rotate `influxTokenWo` without changing other fields.
*/
influxTokenWoVersion?: pulumi.Input<number | undefined>;
/**
* Set to `false` to disable certificate verification for https endpoints. If not set, PVE default is `true`.
*/
influxVerify?: pulumi.Input<boolean | undefined>;
/**
* MTU (maximum transmission unit) for metrics transmission over UDP. If not set, PVE default is `1500` (allowed `512` - `65536`).
*/
mtu?: pulumi.Input<number | undefined>;
/**
* Unique name that will be ID of this metric server in PVE.
*/
name?: pulumi.Input<string | undefined>;
/**
* OpenTelemetry compression algorithm for requests. Choice is between `none` | `gzip`. If not set, PVE default is `gzip`.
*/
opentelemetryCompression?: pulumi.Input<string | undefined>;
/**
* OpenTelemetry custom HTTP headers as JSON, base64 encoded.
*/
opentelemetryHeaders?: pulumi.Input<string | undefined>;
/**
* OpenTelemetry maximum request body size in bytes. If not set, PVE default is `10000000`.
*/
opentelemetryMaxBodySize?: pulumi.Input<number | undefined>;
/**
* OpenTelemetry endpoint path (e.g., `/v1/metrics`).
*/
opentelemetryPath?: pulumi.Input<string | undefined>;
/**
* Protocol for OpenTelemetry. Choice is between `http` | `https`. If not set, PVE default is `https`.
*/
opentelemetryProto?: pulumi.Input<string | undefined>;
/**
* OpenTelemetry additional resource attributes as JSON, base64 encoded.
*/
opentelemetryResourceAttributes?: pulumi.Input<string | undefined>;
/**
* OpenTelemetry HTTP request timeout in seconds. If not set, PVE default is `5`.
*/
opentelemetryTimeout?: pulumi.Input<number | undefined>;
/**
* OpenTelemetry verify SSL certificates. If not set, PVE default is `true`.
*/
opentelemetryVerifySsl?: pulumi.Input<boolean | undefined>;
/**
* Server network port.
*/
port: pulumi.Input<number>;
/**
* Server dns name or IP address.
*/
server: pulumi.Input<string>;
/**
* TCP socket timeout in seconds. If not set, PVE default is `1`.
*/
timeout?: pulumi.Input<number | undefined>;
/**
* Plugin type. Choice is between `graphite` | `influxdb` | `opentelemetry`.
*/
type: pulumi.Input<string>;
}
//# sourceMappingURL=serverLegacy.d.ts.map