Skip to content

Commit

Permalink
Publish Package Metadata for [email protected] (#6021)
Browse files Browse the repository at this point in the history
  • Loading branch information
pulumi-bot authored Nov 18, 2024
1 parent e9b90ed commit f14d5df
Show file tree
Hide file tree
Showing 2 changed files with 120 additions and 8 deletions.
122 changes: 117 additions & 5 deletions themes/default/content/registry/packages/signalfx/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
# WARNING: this file was fetched from https://raw.githubusercontent.com/pulumi/pulumi-signalfx/v7.3.0/docs/_index.md
# WARNING: this file was fetched from https://raw.githubusercontent.com/pulumi/pulumi-signalfx/v7.4.0/docs/_index.md
# Do not edit by hand unless you're certain you know what you are doing!
# *** WARNING: This file was auto-generated. Do not edit by hand unless you're certain you know what you are doing! ***
title: Signalfx Provider
Expand Down Expand Up @@ -27,10 +27,20 @@ To learn more about Splunk Observability Cloud and its features, see [the offici
You can use the SignalFlow programming language to create charts and detectors using `programText`. For more information about SignalFlow, see the [Splunk developer documentation](https://dev.splunk.com/observability/docs/signalflow/).
# Authentication

When authenticating to the Splunk Observability Cloud API you can use either an Org token or a
Session token. See [Authenticate API Requests](https://dev.splunk.com/observability/docs/apibasics/authentication_basics/) in the Splunk developer documentation.
When authenticating to the Splunk Observability Cloud API you can use:

Session tokens are short-lived and provide administrative permissions to edit integrations. They expire relatively quickly, but let you manipulate some sensitive resources. Resources that require session tokens are flagged in their documentation.
1. An Org token.
2. A Session token.
3. A Service account.

See [Authenticate API Requests](https://dev.splunk.com/observability/docs/apibasics/authentication_basics/) in the Splunk developer documentation.

Session tokens are short-lived and provide administrative permissions to edit integrations.
They expire relatively quickly, but let you manipulate some sensitive resources.
Resources that require session tokens are flagged in their documentation.

A Service account is term used when a user is created within organization that can login via Username and Password,
this allows for a *Session Token* to be created by the pulumi provider and then used throughout the application.

> **NOTE** Separate the less sensitive resources, such as dashboards, from the
more sensitive ones, such as integrations, to avoid having to change tokens.
Expand Down Expand Up @@ -203,6 +213,105 @@ public class App {
}
}
```
{{% /choosable %}}
{{< /chooser >}}

{{< chooser language "typescript,python,go,csharp,java,yaml" >}}
{{% choosable language typescript %}}
```yaml
# Pulumi.yaml provider configuration file
name: configuration-example
runtime: nodejs
config:
signalfx:email:
value: service.account@example
signalfx:organizationId:
value: 'TODO: "${var.service_account_org_id}"'
signalfx:password:
value: 'TODO: "${var.service_account_password}"'

```

{{% /choosable %}}
{{% choosable language python %}}
```yaml
# Pulumi.yaml provider configuration file
name: configuration-example
runtime: python
config:
signalfx:email:
value: service.account@example
signalfx:organizationId:
value: 'TODO: "${var.service_account_org_id}"'
signalfx:password:
value: 'TODO: "${var.service_account_password}"'

```

{{% /choosable %}}
{{% choosable language csharp %}}
```yaml
# Pulumi.yaml provider configuration file
name: configuration-example
runtime: dotnet
config:
signalfx:email:
value: service.account@example
signalfx:organizationId:
value: 'TODO: "${var.service_account_org_id}"'
signalfx:password:
value: 'TODO: "${var.service_account_password}"'

```

{{% /choosable %}}
{{% choosable language go %}}
```yaml
# Pulumi.yaml provider configuration file
name: configuration-example
runtime: go
config:
signalfx:email:
value: service.account@example
signalfx:organizationId:
value: 'TODO: "${var.service_account_org_id}"'
signalfx:password:
value: 'TODO: "${var.service_account_password}"'

```

{{% /choosable %}}
{{% choosable language yaml %}}
```yaml
# Pulumi.yaml provider configuration file
name: configuration-example
runtime: yaml
config:
signalfx:email:
value: service.account@example
signalfx:organizationId:
value: 'TODO: "${var.service_account_org_id}"'
signalfx:password:
value: 'TODO: "${var.service_account_password}"'

```

{{% /choosable %}}
{{% choosable language java %}}
```yaml
# Pulumi.yaml provider configuration file
name: configuration-example
runtime: java
config:
signalfx:email:
value: service.account@example
signalfx:organizationId:
value: 'TODO: "${var.service_account_org_id}"'
signalfx:password:
value: 'TODO: "${var.service_account_password}"'

```

{{% /choosable %}}
{{< /chooser >}}
## Configuration Reference
Expand All @@ -215,4 +324,7 @@ The following configuration inputs are supported:
* `timeoutSeconds` - (Optional) The total timeout duration to wait when making HTTP API calls to Splunk Observability Cloud, in seconds. Defaults to `120`.
* `retryMaxAttempts` - (Optional) The number of retry attempts when making HTTP API calls to Splunk Observability Cloud. Defaults to `4`.
* `retryWaitMinSeconds` - (Optional) The minimum wait time between retry attempts when making HTTP API calls to Splunk Observability Cloud, in seconds. Defaults to `1`.
* `retryWaitMaxSeconds` - (Optional) The maximum wait time between retry attempts when making HTTP API calls to Splunk Observability Cloud, in seconds. Defaults to `30`.
* `retryWaitMaxSeconds` - (Optional) The maximum wait time between retry attempts when making HTTP API calls to Splunk Observability Cloud, in seconds. Defaults to `30`.
* `email` - (Optional) The provided email address is used to generate a *Session Token* that is then used for all API interactions. Requires email address to be configured with a password, and not via SSO.
* `password` - (Optional) The password is used to authenticate the email provided to generate a *Session Token*. Requires email address to be configured with a password, and not via SSO.
* `organizationId` - (Optional) The organisation id is used to select which organization if the user provided belongs to multiple.
6 changes: 3 additions & 3 deletions themes/default/data/registry/packages/signalfx.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ native: false
package_status: ga
publisher: Pulumi
repo_url: https://github.com/pulumi/pulumi-signalfx
schema_file_path: ""
schema_file_url: https://raw.githubusercontent.com/pulumi/pulumi-signalfx/v7.4.0/provider/cmd/pulumi-resource-signalfx/schema.json
title: SignalFx
updated_on: 1731670248
version: v7.3.0
updated_on: 1731929103
version: v7.4.0

0 comments on commit f14d5df

Please sign in to comment.