Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Upgrade terraform-provider-signalfx to v9.4.0 #608

Merged
merged 2 commits into from
Nov 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
120 changes: 116 additions & 4 deletions docs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,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 @@ -201,6 +211,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 @@ -213,4 +322,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.
36 changes: 36 additions & 0 deletions provider/cmd/pulumi-resource-signalfx/schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,18 @@
"type": "string",
"description": "Application URL for your Splunk Observability Cloud org, often customized for organizations using SSO\n"
},
"email": {
"type": "string",
"description": "Used to create a session token instead of an API token, it requires the account to be configured to login with Email and\nPassword\n"
},
"organizationId": {
"type": "string",
"description": "Required if the user is configured to be part of multiple organizations\n"
},
"password": {
"type": "string",
"description": "Used to create a session token instead of an API token, it requires the account to be configured to login with Email and\nPassword\n"
},
"retryMaxAttempts": {
"type": "integer",
"description": "Max retries for a single HTTP call. Defaults to 4\n"
Expand Down Expand Up @@ -1833,6 +1845,18 @@
"type": "string",
"description": "Application URL for your Splunk Observability Cloud org, often customized for organizations using SSO\n"
},
"email": {
"type": "string",
"description": "Used to create a session token instead of an API token, it requires the account to be configured to login with Email and\nPassword\n"
},
"organizationId": {
"type": "string",
"description": "Required if the user is configured to be part of multiple organizations\n"
},
"password": {
"type": "string",
"description": "Used to create a session token instead of an API token, it requires the account to be configured to login with Email and\nPassword\n"
},
"retryMaxAttempts": {
"type": "integer",
"description": "Max retries for a single HTTP call. Defaults to 4\n"
Expand Down Expand Up @@ -1863,6 +1887,18 @@
"type": "string",
"description": "Application URL for your Splunk Observability Cloud org, often customized for organizations using SSO\n"
},
"email": {
"type": "string",
"description": "Used to create a session token instead of an API token, it requires the account to be configured to login with Email and\nPassword\n"
},
"organizationId": {
"type": "string",
"description": "Required if the user is configured to be part of multiple organizations\n"
},
"password": {
"type": "string",
"description": "Used to create a session token instead of an API token, it requires the account to be configured to login with Email and\nPassword\n"
},
"retryMaxAttempts": {
"type": "integer",
"description": "Max retries for a single HTTP call. Defaults to 4\n"
Expand Down
2 changes: 1 addition & 1 deletion provider/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ toolchain go1.23.3
require (
github.com/pulumi/pulumi-terraform-bridge/v3 v3.95.0
github.com/pulumi/pulumi/sdk/v3 v3.137.0
github.com/splunk-terraform/terraform-provider-signalfx v1.9.2-0.20241114103820-a93a94bc52b7
github.com/splunk-terraform/terraform-provider-signalfx v1.9.2-0.20241117222702-94c91d49dc88
)

replace (
Expand Down
4 changes: 2 additions & 2 deletions provider/go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -1955,8 +1955,8 @@ github.com/spf13/pflag v1.0.2/go.mod h1:DYY7MBk1bdzusC3SYhjObp+wFpr4gzcvqqNjLnIn
github.com/spf13/pflag v1.0.3/go.mod h1:DYY7MBk1bdzusC3SYhjObp+wFpr4gzcvqqNjLnInEg4=
github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
github.com/splunk-terraform/terraform-provider-signalfx v1.9.2-0.20241114103820-a93a94bc52b7 h1:rnGSxnlAjJFY1NfMRFJYDb9oJnLxeSdZmfIQ4AiPMew=
github.com/splunk-terraform/terraform-provider-signalfx v1.9.2-0.20241114103820-a93a94bc52b7/go.mod h1:2bzQ3b1oLbwoZPv7VeIxeJI81YL9j46AIwpJ6X7Hwkk=
github.com/splunk-terraform/terraform-provider-signalfx v1.9.2-0.20241117222702-94c91d49dc88 h1:U4l8C9bjqFisbxIrKqzLY+qu5lIS6p6jRjnDt7wG0II=
github.com/splunk-terraform/terraform-provider-signalfx v1.9.2-0.20241117222702-94c91d49dc88/go.mod h1:2bzQ3b1oLbwoZPv7VeIxeJI81YL9j46AIwpJ6X7Hwkk=
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
Expand Down
32 changes: 32 additions & 0 deletions sdk/dotnet/Config/Config.cs

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

40 changes: 40 additions & 0 deletions sdk/dotnet/Provider.cs

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

17 changes: 17 additions & 0 deletions sdk/go/signalfx/config/config.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading