Skip to content

Commit

Permalink
Add installation docs with automation (#455)
Browse files Browse the repository at this point in the history
Part of pulumi/home#3598

Generates a single index.md file with relevant content and adds
automation.
  • Loading branch information
guineveresaenger authored Oct 7, 2024
1 parent cea65f8 commit 761a54f
Show file tree
Hide file tree
Showing 3 changed files with 117 additions and 1 deletion.
1 change: 1 addition & 0 deletions .ci-mgmt.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ env:
makeTemplate: bridged
team: ecosystem
pulumiConvert: 1
registryDocs: true
plugins:
- name: terraform
version: "1.0.16"
Expand Down
6 changes: 5 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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}

Expand Down
111 changes: 111 additions & 0 deletions docs/_index.md
Original file line number Diff line number Diff line change
@@ -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: <rke_log_file>

```

{{% /choosable %}}
{{% choosable language python %}}
```yaml
# Pulumi.yaml provider configuration file
name: configuration-example
runtime: python
config:
rke:debug:
value: true
rke:logFile:
value: <rke_log_file>

```

{{% /choosable %}}
{{% choosable language csharp %}}
```yaml
# Pulumi.yaml provider configuration file
name: configuration-example
runtime: dotnet
config:
rke:debug:
value: true
rke:logFile:
value: <rke_log_file>

```

{{% /choosable %}}
{{% choosable language go %}}
```yaml
# Pulumi.yaml provider configuration file
name: configuration-example
runtime: go
config:
rke:debug:
value: true
rke:logFile:
value: <rke_log_file>

```

{{% /choosable %}}
{{% choosable language yaml %}}
```yaml
# Pulumi.yaml provider configuration file
name: configuration-example
runtime: yaml
config:
rke:debug:
value: true
rke:logFile:
value: <rke_log_file>

```

{{% /choosable %}}
{{% choosable language java %}}
```yaml
# Pulumi.yaml provider configuration file
name: configuration-example
runtime: java
config:
rke:debug:
value: true
rke:logFile:
value: <rke_log_file>

```

{{% /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)

0 comments on commit 761a54f

Please sign in to comment.