Skip to content
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
8 changes: 6 additions & 2 deletions docs/resources/function.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,12 @@ description: |-
- `retain_key_ordering` (Boolean) Whether to retain key ordering when the function is restarted after failure.
- `retain_ordering` (Boolean) Whether to retain ordering when the function is restarted after failure.
- `secrets` (String) The secrets of the function.
- `sink_config` (Block List) Sink configuration key/values serialized into custom_runtime_options.
- `configs` (Map of String) Sink-specific key/value pairs. Non-string values are stringified during state reconciliation.
- `sink_type` (String) Sink implementation identifier, for example `kafka`.
- `source_config` (Block List) Source configuration key/values serialized into custom_runtime_options.
- `configs` (Map of String) Source-specific key/value pairs. Non-string values are stringified during state reconciliation.
- `source_type` (String) Source implementation identifier, for example `kinesis`.
- `skip_to_latest` (Boolean) Whether to skip to the latest position when the function is restarted after failure.
- `subscription_name` (String) The subscription name of the function.
- `subscription_position` (String) The subscription position of the function. Possible values are `LATEST`, `EARLIEST`, and `CUSTOM`.
Expand All @@ -61,5 +67,3 @@ description: |-
### Read-Only

- `id` (String) The ID of this resource.


46 changes: 46 additions & 0 deletions docs/resources/package.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "pulsar_package Resource - terraform-provider-pulsar"
subcategory: ""
description: |-
Manages Pulsar packages that store runnable artifacts for functions, sources, and sinks.
---

# pulsar_package (Resource)

Manages Pulsar packages that store runnable artifacts for functions, sources, and sinks. Packages are referenced by
other resources via their fully-qualified URL (`<type>://<tenant>/<namespace>/<name>@<version>`). The provider uploads
the local archive file, keeps metadata (description, contact, properties) in sync, and tracks the local file checksum
so Terraform detects archive changes.

> **Important:** The archive file referenced by `path` must exist on the machine running `terraform plan`/`apply`
> because the provider computes the SHA256 checksum to trigger updates when the file contents change.

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `name` (String) Package name.
- `namespace` (String) Namespace that owns the package.
- `path` (String) Local path to the archive file that should be uploaded.
- `tenant` (String) Tenant that owns the package.
- `type` (String) Package type. Supported values: `function`, `sink`, `source`.
- `version` (String) Package version. Changing the version creates a new package resource.

### Optional

- `contact` (String) Contact information stored alongside the package metadata.
- `description` (String) Optional package description stored alongside the package metadata.
- `properties` (Map of String) Additional user-defined metadata properties.

### Read-Only

- `create_time` (Number) Server-side package creation timestamp (epoch millis).
- `file_checksum` (String) Checksum reported by Pulsar for the uploaded archive.
- `file_name` (String) Archive file name stored in metadata.
- `file_size` (Number) Archive size reported by Pulsar (bytes).
- `id` (String) The ID of this resource.
- `modification_time` (Number) Server-side package modification timestamp (epoch millis).
- `package_url` (String) Fully-qualified package URL.
- `source_hash` (String) SHA256 checksum of the local archive used to trigger updates when the file changes.
1 change: 1 addition & 0 deletions pulsar/provider.go
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,7 @@ func Provider() *schema.Provider {
"pulsar_function": resourcePulsarFunction(),
"pulsar_subscription": resourcePulsarSubscription(),
"pulsar_permission_grant": resourcePulsarPermissionGrant(),
"pulsar_package": resourcePulsarPackage(),
},
}

Expand Down
Loading
Loading