Kibana action connectors

Makefile

@@ -67,17 +67,20 @@ retry = until [ $$(if [ -z "$$attempt" ]; then echo -n "0"; else echo -n "$$atte
 		backoff=$$((backoff * 2)); \
 	done
 
+# To run specific test (e.g. TestAccResourceActionConnector) execute `make docker-testacc TESTARGS='-run ^TestAccResourceActionConnector$$'`
+# To enable tracing (or debugging), execute `make docker-testacc TFLOG=TRACE`
 .PHONY: docker-testacc
 docker-testacc: docker-elasticsearch docker-kibana ## Run acceptance tests in the docker container
 	@ docker run --rm \
 		-e ELASTICSEARCH_ENDPOINTS="$(ELASTICSEARCH_ENDPOINTS)" \
 		-e KIBANA_ENDPOINT="$(KIBANA_ENDPOINT)" \
 		-e ELASTICSEARCH_USERNAME="$(ELASTICSEARCH_USERNAME)" \
 		-e ELASTICSEARCH_PASSWORD="$(ELASTICSEARCH_PASSWORD)" \
+		-e TF_LOG="$(TF_LOG)" \
 		--network $(ELASTICSEARCH_NETWORK) \
 		-w "/provider" \
 		-v "$(SOURCE_LOCATION):/provider" \
-		golang:$(GOVERSION) make testacc
+		golang:$(GOVERSION) make testacc TESTARGS="$(TESTARGS)"
 
 .PHONY: docker-elasticsearch
 docker-elasticsearch: docker-network ## Start Elasticsearch single node cluster in docker container
@@ -159,7 +162,6 @@ tools: $(GOBIN) ## Install useful tools for linting, docs generation and develop
 	@ cd tools && go install github.com/goreleaser/goreleaser
 	@ cd tools && go install github.com/deepmap/oapi-codegen/cmd/oapi-codegen
 
-
 .PHONY: misspell
 misspell:
 	@ $(GOBIN)/misspell -error -source go ./internal/
@@ -247,11 +249,15 @@ generate-alerting-client: ## generate Kibana alerting client
 		-g go \
 		-o /local/generated/alerting
 	@ rm -rf generated/alerting/go.mod generated/alerting/go.sum generated/alerting/test
-	@ go fmt ./generated/...
+	@ go fmt ./generated/alerting/...
 
+.PHONY: generate-connectors-client
+generate-connectors-client: tools ## generate Kibana connectors client
+	@ cd tools && go generate
+	@ go fmt ./generated/connectors/...
 
 .PHONY: generate-slo-client
-generate-slo-client: ## generate Kibana slo client
+generate-slo-client: tools ## generate Kibana slo client
 	@ docker run --rm -v "${PWD}:/local" openapitools/openapi-generator-cli generate \
 		-i https://raw.githubusercontent.com/elastic/kibana/master/x-pack/plugins/observability/docs/openapi/slo/bundled.yaml \
 		--skip-validate-spec \
@@ -266,4 +272,4 @@ generate-slo-client: ## generate Kibana slo client
 	@ go fmt ./generated/...
 
 .PHONY: generate-clients
-generate-clients: generate-alerting-client generate-slo-client ## generate all clients
+generate-clients: generate-alerting-client generate-slo-client generate-connectors-client ## generate all clients

README.md

@@ -129,3 +129,8 @@ go mod tidy
 ```
 
 Then commit the changes to `go.mod` and `go.sum`.
+
+### Generating Kibana clients
+
+Kibana clients for some APIs are generated based on Kibana OpenAPI specs.
+Please see [Makefile](./Makefile) tasks for more details.

docs/resources/kibana_action_connector.md

@@ -0,0 +1,58 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "elasticstack_kibana_action_connector Resource - terraform-provider-elasticstack"
+subcategory: ""
+description: |-
+  Creates a Kibana action connector. See https://www.elastic.co/guide/en/kibana/8.7/action-types.html
+---
+
+# elasticstack_kibana_action_connector (Resource)
+
+Creates a Kibana action connector. See https://www.elastic.co/guide/en/kibana/8.7/action-types.html
+
+## Example Usage
+
+```terraform
+provider "elasticstack" {
+  elasticsearch {}
+}
+
+resource "elasticstack_kibana_action_connector" "example" {
+  name = "%s"
+  config = jsonencode({
+    index   = ".kibana"
+    refresh = true
+  })
+  connector_type_id = ".index"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `connector_type_id` (String) The ID of the connector type, e.g. `.index`.
+- `name` (String) The name of the connector. While this name does not have to be unique, a distinctive name can help you identify a connector.
+
+### Optional
+
+- `config` (String) The configuration for the connector. Configuration properties vary depending on the connector type.
+- `connector_id` (String) A UUID v1 or v4 to use instead of a randomly generated ID.
+- `secrets` (String) The secrets configuration for the connector. Secrets configuration properties vary depending on the connector type.
+- `space_id` (String) An identifier for the space. If space_id is not provided, the default space is used.
+
+### Read-Only
+
+- `id` (String) The ID of this resource.
+- `is_deprecated` (Boolean) Indicates whether the connector type is deprecated.
+- `is_missing_secrets` (Boolean) Indicates whether secrets are missing for the connector.
+- `is_preconfigured` (Boolean) Indicates whether it is a preconfigured connector.
+
+## Import
+
+Import is supported using the following syntax:
+
+```shell
+terraform import elasticstack_kibana_action_connector.my_connector <space id>/<connector id>
+```

examples/resources/elasticstack_kibana_action_connector/import.sh

@@ -0,0 +1 @@
+terraform import elasticstack_kibana_action_connector.my_connector <space id>/<connector id>

examples/resources/elasticstack_kibana_action_connector/resource.tf

@@ -0,0 +1,12 @@
+provider "elasticstack" {
+  elasticsearch {}
+}
+
+resource "elasticstack_kibana_action_connector" "example" {
+  name = "%s"
+  config = jsonencode({
+    index   = ".kibana"
+    refresh = true
+  })
+  connector_type_id = ".index"
+}

generated/connectors/README.md

@@ -0,0 +1,39 @@
+[OpenAPI specs](./bundled.yaml) is copied from [Kibana repo](https://raw.githubusercontent.com/elastic/kibana/8.7/x-pack/plugins/actions/docs/openapi/bundled.yaml) with some modifications:
+
+- added mapping section for discriminator field in `POST` `/s/{spaceId}/api/actions/connector`;
+- added explicit object definitions for `400`, `401` and `404` errors (`oapi-codegen` doesn't generate proper code for embedded anonymous objects in some cases) - `bad_request_error`, `authorization_error` and `object_not_found_error`;
+- added missing `oneOf` types in `requestBody` for `PUT` `/s/{spaceId}/api/actions/connector/{connectorId}` - the original `bundled.yaml` misses some connector types in the `PUT` `requestBody` defintion:
+  - `update_connector_request_email`;
+  - `update_connector_request_pagerduty`;
+  - `update_connector_request_servicenow_sir`;
+  - `update_connector_request_slack`;
+  - `update_connector_request_teams`;
+  - `update_connector_request_tines`;
+  - `update_connector_request_webhook`;
+  - `update_connector_request_xmatters`.
+- response definitions of `/s/{spaceId}/api/actions/connector/{connectorId}/_execute` and `/s/{spaceId}/api/actions/action/{actionId}/_execute` are modified from embedded object definitions to named ones `run_connector_general_response` and `legacy_run_connector_general_response`;
+- specified properties for following types. The original `bundled.yaml` defines them as dynamic objects (`additionalProperties: true`):
+  - `config_propeties_email`;
+  - `config_properties_pagerduty`;
+  - `config_properties_tines`;
+  - `config_properties_webhook`;
+  - `config_properties_xmatters`;
+- `is_deprecated` is marked as optional field (it's required field in the vanilla `bundled.yaml`) in the following objects (Kibana responses may omit it):
+  - `connector_response_properties_cases_webhook`; 
+  - `connector_response_properties_email`;
+  - `connector_response_properties_index`;
+  - `connector_response_properties_jira`;
+  - `connector_response_properties_opsgenie`;
+  - `connector_response_properties_pagerduty`;
+  - `connector_response_properties_resilient`;
+  - `connector_response_properties_serverlog`;
+  - `connector_response_properties_servicenow`;
+  - `connector_response_properties_servicenow_itom`;
+  - `connector_response_properties_servicenow_sir`;
+  - `connector_response_properties_slack`;
+  - `connector_response_properties_swimlane`;
+  - `connector_response_properties_teams`;
+  - `connector_response_properties_tines`;
+  - `connector_response_properties_webhook`;
+  - `connector_response_properties_xmatters`.
+- added mapping section for discriminator field in `connector_response_properties`.