@kubernetes-models/flux-cd
Version:
86 lines (85 loc) • 3.76 kB
TypeScript
import { IObjectMeta } from "@kubernetes-models/apimachinery/apis/meta/v1/ObjectMeta";
import { Model, ModelData } from "@kubernetes-models/base";
/**
* Provider is the Schema for the providers API
*/
export interface IProvider {
/**
* APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
*/
"apiVersion": "notification.toolkit.fluxcd.io/v1beta3";
/**
* Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
*/
"kind": "Provider";
"metadata"?: IObjectMeta;
/**
* ProviderSpec defines the desired state of the Provider.
*/
"spec"?: {
/**
* Address specifies the endpoint, in a generic sense, to where alerts are sent. What kind of endpoint depends on the specific Provider type being used. For the generic Provider, for example, this is an HTTP/S address. For other Provider types this could be a project ID or a namespace.
*/
"address"?: string;
/**
* CertSecretRef specifies the Secret containing a PEM-encoded CA certificate (in the `ca.crt` key).
* Note: Support for the `caFile` key has been deprecated.
*/
"certSecretRef"?: {
/**
* Name of the referent.
*/
"name": string;
};
/**
* Channel specifies the destination channel where events should be posted.
*/
"channel"?: string;
/**
* Interval at which to reconcile the Provider with its Secret references. Deprecated and not used in v1beta3.
*/
"interval"?: string;
/**
* Proxy the HTTP/S address of the proxy server.
*/
"proxy"?: string;
/**
* SecretRef specifies the Secret containing the authentication credentials for this Provider.
*/
"secretRef"?: {
/**
* Name of the referent.
*/
"name": string;
};
/**
* Suspend tells the controller to suspend subsequent events handling for this Provider.
*/
"suspend"?: boolean;
/**
* Timeout for sending alerts to the Provider.
*/
"timeout"?: string;
/**
* Type specifies which Provider implementation to use.
*/
"type": "slack" | "discord" | "msteams" | "rocket" | "generic" | "generic-hmac" | "github" | "gitlab" | "gitea" | "bitbucketserver" | "bitbucket" | "azuredevops" | "googlechat" | "googlepubsub" | "webex" | "sentry" | "azureeventhub" | "telegram" | "lark" | "matrix" | "opsgenie" | "alertmanager" | "grafana" | "githubdispatch" | "pagerduty" | "datadog" | "nats";
/**
* Username specifies the name under which events are posted.
*/
"username"?: string;
};
}
/**
* Provider is the Schema for the providers API
*/
export declare class Provider extends Model<IProvider> implements IProvider {
"apiVersion": IProvider["apiVersion"];
"kind": IProvider["kind"];
"metadata"?: IProvider["metadata"];
"spec"?: IProvider["spec"];
static apiVersion: IProvider["apiVersion"];
static kind: IProvider["kind"];
static is: import("@kubernetes-models/base").TypeMetaGuard<IProvider>;
constructor(data?: ModelData<IProvider>);
}