diff --git a/.ci-mgmt.yaml b/.ci-mgmt.yaml index 9d39206..46d0e9c 100644 --- a/.ci-mgmt.yaml +++ b/.ci-mgmt.yaml @@ -6,6 +6,7 @@ env: makeTemplate: bridged team: ecosystem pulumiConvert: 1 +registryDocs: true plugins: - name: terraform version: "1.0.16" diff --git a/Makefile b/Makefile index be6c1f9..80bdae9 100644 --- a/Makefile +++ b/Makefile @@ -29,7 +29,7 @@ development: install_plugins provider build_sdks install_sdks build: install_plugins provider build_sdks install_sdks -build_sdks: build_nodejs build_python build_dotnet build_go build_java +build_sdks: build_nodejs build_python build_dotnet build_go build_java build_registry_docs install_go_sdk: @@ -96,6 +96,10 @@ build_python: upstream cd ./bin && \ ../venv/bin/python -m build . +# Run the bridge's registry-docs command to generated the content of the installation docs/ folder at provider repo root +build_registry_docs: + $(WORKING_DIR)/bin/$(TFGEN) registry-docs --out $(WORKING_DIR)/docs + clean: rm -rf sdk/{dotnet,nodejs,go,python} diff --git a/docs/_index.md b/docs/_index.md new file mode 100644 index 0000000..a2ee1d9 --- /dev/null +++ b/docs/_index.md @@ -0,0 +1,111 @@ +--- +title: Rke Provider +meta_desc: Provides an overview on how to configure the Pulumi Rke provider. +layout: package +--- +## Installation + +The rke provider is available as a package in all Pulumi languages: + +* JavaScript/TypeScript: [`@pulumi/rke`](https://www.npmjs.com/package/@pulumi/rke) +* Python: [`pulumi-rke`](https://pypi.org/project/pulumi-rke/) +* Go: [`github.com/pulumi/pulumi-rke/sdk/v3/go/rke`](https://github.com/pulumi/pulumi-rke) +* .NET: [`Pulumi.Rke`](https://www.nuget.org/packages/Pulumi.Rke) +* Java: [`com.pulumi/rke`](https://central.sonatype.com/artifact/com.pulumi/rke) +## Overview + +The RKE provider is used to interact with Rancher Kubernetes Engine kubernetes clusters. +## Example Usage + +{{< chooser language "typescript,python,go,csharp,java,yaml" >}} +{{% choosable language typescript %}} +```yaml +# Pulumi.yaml provider configuration file +name: configuration-example +runtime: nodejs +config: + rke:debug: + value: true + rke:logFile: + value: + +``` + +{{% /choosable %}} +{{% choosable language python %}} +```yaml +# Pulumi.yaml provider configuration file +name: configuration-example +runtime: python +config: + rke:debug: + value: true + rke:logFile: + value: + +``` + +{{% /choosable %}} +{{% choosable language csharp %}} +```yaml +# Pulumi.yaml provider configuration file +name: configuration-example +runtime: dotnet +config: + rke:debug: + value: true + rke:logFile: + value: + +``` + +{{% /choosable %}} +{{% choosable language go %}} +```yaml +# Pulumi.yaml provider configuration file +name: configuration-example +runtime: go +config: + rke:debug: + value: true + rke:logFile: + value: + +``` + +{{% /choosable %}} +{{% choosable language yaml %}} +```yaml +# Pulumi.yaml provider configuration file +name: configuration-example +runtime: yaml +config: + rke:debug: + value: true + rke:logFile: + value: + +``` + +{{% /choosable %}} +{{% choosable language java %}} +```yaml +# Pulumi.yaml provider configuration file +name: configuration-example +runtime: java +config: + rke:debug: + value: true + rke:logFile: + value: + +``` + +{{% /choosable %}} +{{< /chooser >}} +## Configuration Reference + +The following configuration inputs are supported: + +* `debug` - (Optional) Enable RKE debug logs. It can also be sourced from the `RKE_DEBUG` environment variable. Default `false` (bool) +* `logFile` - (Optional) Save RKE logs to a file. It can also be sourced from the `RKE_LOG_FILE` environment variable (string) \ No newline at end of file