Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now

getClusterLogging

Use this data source to retrieve information about a Rancher v2 Cluster Logging.

Example Usage

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
    public MyStack()
    {
        var foo = Output.Create(Rancher2.GetClusterLogging.InvokeAsync(new Rancher2.GetClusterLoggingArgs
        {
            ClusterId = "<cluster_id>",
        }));
    }

}
package main

import (
    "github.com/pulumi/pulumi-rancher2/sdk/v2/go/rancher2"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := rancher2.LookupClusterLogging(ctx, &rancher2.LookupClusterLoggingArgs{
            ClusterId: "<cluster_id>",
        }, nil)
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_rancher2 as rancher2

foo = rancher2.get_cluster_logging(cluster_id="<cluster_id>")
import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

const foo = pulumi.output(rancher2.getClusterLogging({
    clusterId: "<cluster_id>",
}, { async: true }));

Using getClusterLogging

function getClusterLogging(args: GetClusterLoggingArgs, opts?: InvokeOptions): Promise<GetClusterLoggingResult>
def get_cluster_logging(cluster_id: Optional[str] = None, opts: Optional[InvokeOptions] = None) -> GetClusterLoggingResult
func LookupClusterLogging(ctx *Context, args *LookupClusterLoggingArgs, opts ...InvokeOption) (*LookupClusterLoggingResult, error)

Note: This function is named LookupClusterLogging in the Go SDK.

public static class GetClusterLogging {
    public static Task<GetClusterLoggingResult> InvokeAsync(GetClusterLoggingArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

ClusterId string

The cluster id to configure logging (string)

ClusterId string

The cluster id to configure logging (string)

clusterId string

The cluster id to configure logging (string)

cluster_id str

The cluster id to configure logging (string)

getClusterLogging Result

The following output properties are available:

Annotations Dictionary<string, object>

(Computed) Annotations for Cluster Logging object (map)

ClusterId string
CustomTargetConfig GetClusterLoggingCustomTargetConfig
ElasticsearchConfig GetClusterLoggingElasticsearchConfig

(Computed) The elasticsearch config for Cluster Logging. For kind = elasticsearch (list maxitems:1)

EnableJsonParsing bool
FluentdConfig GetClusterLoggingFluentdConfig

(Computed) The fluentd config for Cluster Logging. For kind = fluentd (list maxitems:1)

Id string

The provider-assigned unique ID for this managed resource.

KafkaConfig GetClusterLoggingKafkaConfig

(Computed) The kafka config for Cluster Logging. For kind = kafka (list maxitems:1)

Kind string

(Computed) The kind of the Cluster Logging. elasticsearch, fluentd, kafka, splunk and syslog are supported (string)

Labels Dictionary<string, object>

(Computed) Labels for Cluster Logging object (map)

Name string

(Computed) The name of the cluster logging config (string)

NamespaceId string

(Computed) The namespace id from cluster logging (string)

OutputFlushInterval int

(Computed) How often buffered logs would be flushed. Default: 3 seconds (int)

OutputTags Dictionary<string, object>

(computed) The output tags for Cluster Logging (map)

SplunkConfig GetClusterLoggingSplunkConfig

(Computed) The splunk config for Cluster Logging. For kind = splunk (list maxitems:1)

SyslogConfig GetClusterLoggingSyslogConfig

(Computed) The syslog config for Cluster Logging. For kind = syslog (list maxitems:1)

Annotations map[string]interface{}

(Computed) Annotations for Cluster Logging object (map)

ClusterId string
CustomTargetConfig GetClusterLoggingCustomTargetConfig
ElasticsearchConfig GetClusterLoggingElasticsearchConfig

(Computed) The elasticsearch config for Cluster Logging. For kind = elasticsearch (list maxitems:1)

EnableJsonParsing bool
FluentdConfig GetClusterLoggingFluentdConfig

(Computed) The fluentd config for Cluster Logging. For kind = fluentd (list maxitems:1)

Id string

The provider-assigned unique ID for this managed resource.

KafkaConfig GetClusterLoggingKafkaConfig

(Computed) The kafka config for Cluster Logging. For kind = kafka (list maxitems:1)

Kind string

(Computed) The kind of the Cluster Logging. elasticsearch, fluentd, kafka, splunk and syslog are supported (string)

Labels map[string]interface{}

(Computed) Labels for Cluster Logging object (map)

Name string

(Computed) The name of the cluster logging config (string)

NamespaceId string

(Computed) The namespace id from cluster logging (string)

OutputFlushInterval int

(Computed) How often buffered logs would be flushed. Default: 3 seconds (int)

OutputTags map[string]interface{}

(computed) The output tags for Cluster Logging (map)

SplunkConfig GetClusterLoggingSplunkConfig

(Computed) The splunk config for Cluster Logging. For kind = splunk (list maxitems:1)

SyslogConfig GetClusterLoggingSyslogConfig

(Computed) The syslog config for Cluster Logging. For kind = syslog (list maxitems:1)

annotations {[key: string]: any}

(Computed) Annotations for Cluster Logging object (map)

clusterId string
customTargetConfig GetClusterLoggingCustomTargetConfig
elasticsearchConfig GetClusterLoggingElasticsearchConfig

(Computed) The elasticsearch config for Cluster Logging. For kind = elasticsearch (list maxitems:1)

enableJsonParsing boolean
fluentdConfig GetClusterLoggingFluentdConfig

(Computed) The fluentd config for Cluster Logging. For kind = fluentd (list maxitems:1)

id string

The provider-assigned unique ID for this managed resource.

kafkaConfig GetClusterLoggingKafkaConfig

(Computed) The kafka config for Cluster Logging. For kind = kafka (list maxitems:1)

kind string

(Computed) The kind of the Cluster Logging. elasticsearch, fluentd, kafka, splunk and syslog are supported (string)

labels {[key: string]: any}

(Computed) Labels for Cluster Logging object (map)

name string

(Computed) The name of the cluster logging config (string)

namespaceId string

(Computed) The namespace id from cluster logging (string)

outputFlushInterval number

(Computed) How often buffered logs would be flushed. Default: 3 seconds (int)

outputTags {[key: string]: any}

(computed) The output tags for Cluster Logging (map)

splunkConfig GetClusterLoggingSplunkConfig

(Computed) The splunk config for Cluster Logging. For kind = splunk (list maxitems:1)

syslogConfig GetClusterLoggingSyslogConfig

(Computed) The syslog config for Cluster Logging. For kind = syslog (list maxitems:1)

annotations Mapping[str, Any]

(Computed) Annotations for Cluster Logging object (map)

cluster_id str
custom_target_config GetClusterLoggingCustomTargetConfig
elasticsearch_config GetClusterLoggingElasticsearchConfig

(Computed) The elasticsearch config for Cluster Logging. For kind = elasticsearch (list maxitems:1)

enable_json_parsing bool
fluentd_config GetClusterLoggingFluentdConfig

(Computed) The fluentd config for Cluster Logging. For kind = fluentd (list maxitems:1)

id str

The provider-assigned unique ID for this managed resource.

kafka_config GetClusterLoggingKafkaConfig

(Computed) The kafka config for Cluster Logging. For kind = kafka (list maxitems:1)

kind str

(Computed) The kind of the Cluster Logging. elasticsearch, fluentd, kafka, splunk and syslog are supported (string)

labels Mapping[str, Any]

(Computed) Labels for Cluster Logging object (map)

name str

(Computed) The name of the cluster logging config (string)

namespace_id str

(Computed) The namespace id from cluster logging (string)

output_flush_interval int

(Computed) How often buffered logs would be flushed. Default: 3 seconds (int)

output_tags Mapping[str, Any]

(computed) The output tags for Cluster Logging (map)

splunk_config GetClusterLoggingSplunkConfig

(Computed) The splunk config for Cluster Logging. For kind = splunk (list maxitems:1)

syslog_config GetClusterLoggingSyslogConfig

(Computed) The syslog config for Cluster Logging. For kind = syslog (list maxitems:1)

Supporting Types

GetClusterLoggingCustomTargetConfig

Content string
Certificate string
ClientCert string
ClientKey string
Content string
Certificate string
ClientCert string
ClientKey string
content string
certificate string
clientCert string
clientKey string

GetClusterLoggingElasticsearchConfig

endpoint string
sslVerify boolean
authPassword string
authUsername string
certificate string
clientCert string
clientKey string
clientKeyPass string
dateFormat string
indexPrefix string
sslVersion string

GetClusterLoggingFluentdConfig

GetClusterLoggingFluentdConfigFluentServer

Endpoint string
Hostname string
Password string
SharedKey string
Standby bool
Username string
Weight int
Endpoint string
Hostname string
Password string
SharedKey string
Standby bool
Username string
Weight int
endpoint string
hostname string
password string
sharedKey string
standby boolean
username string
weight number

GetClusterLoggingKafkaConfig

Topic string
BrokerEndpoints List<string>
Certificate string
ClientCert string
ClientKey string
ZookeeperEndpoint string

GetClusterLoggingSplunkConfig

Endpoint string
SslVerify bool
Token string
Certificate string
ClientCert string
ClientKey string
ClientKeyPass string
Index string
Source string
Endpoint string
SslVerify bool
Token string
Certificate string
ClientCert string
ClientKey string
ClientKeyPass string
Index string
Source string
endpoint string
sslVerify boolean
token string
certificate string
clientCert string
clientKey string
clientKeyPass string
index string
source string

GetClusterLoggingSyslogConfig

Endpoint string
SslVerify bool
Certificate string
ClientCert string
ClientKey string
EnableTls bool
Program string
Protocol string
Severity string
Token string
Endpoint string
SslVerify bool
Certificate string
ClientCert string
ClientKey string
EnableTls bool
Program string
Protocol string
Severity string
Token string
endpoint string
sslVerify boolean
certificate string
clientCert string
clientKey string
enableTls boolean
program string
protocol string
severity string
token string

Package Details

Repository
https://github.com/pulumi/pulumi-rancher2
License
Apache-2.0
Notes
This Pulumi package is based on the rancher2 Terraform Provider.