Skip to content

Commit

Permalink
prepare registry docs
Browse files Browse the repository at this point in the history
  • Loading branch information
philipkrueck committed Mar 19, 2024
1 parent da095ae commit b0b06fa
Show file tree
Hide file tree
Showing 12 changed files with 26 additions and 30 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ VERSION_PATH := ${PROVIDER_PATH}/pkg/version.Version
TFGEN := pulumi-tfgen-${PACK}
PROVIDER := pulumi-resource-${PACK}

VERSION := $(shell pulumictl get version)
VERSION := v0.0.7

TESTPARALLELISM := 4

Expand Down
2 changes: 1 addition & 1 deletion docs/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Genesis Cloud
meta_desc: Provides an overview of the Genesis Cloud Provider for Pulumi.
layout: overview
layout: package
---

The Genesis Cloud provider for Pulumi can be used to provision any of the cloud resources available in [Genesis Cloud](https://www.genesiscloud.com).
Expand Down
8 changes: 5 additions & 3 deletions provider/cmd/pulumi-resource-genesiscloud/schema.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
{
"name": "genesiscloud",
"version": "v0.0.6",
"displayName": "Genesis Cloud",
"version": "v0.0.7",
"description": "A Pulumi package for creating and managing genesiscloud cloud resources.",
"keywords": ["pulumi", "genesiscloud", "category/cloud"],
"homepage": "https://www.genesiscloud.com",
"homepage": "https://www.pulumi.io",
"license": "Apache-2.0",
"attribution": "This Pulumi package is based on the [`genesiscloud` Terraform Provider](https://github.com/genesiscloud/terraform-provider-genesiscloud).",
"repository": "https://github.com/genesiscloud/pulumi-genesiscloud",
"pluginDownloadURL": "https://github.com/genesiscloud/pulumi-genesiscloud/releases/",
"logoUrl": "https://avatars.githubusercontent.com/u/38134186?s=200\u0026v=4",
"pluginDownloadURL": "github://api.github.com/genesiscloud",
"meta": { "moduleFormat": "(.*)(?:/[^/]*)" },
"language": {
"csharp": {
Expand Down
3 changes: 2 additions & 1 deletion provider/resources.go
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@ func Provider() tfbridge.ProviderInfo {
License: "Apache-2.0",
Homepage: "https://www.pulumi.io",
Repository: "https://github.com/genesiscloud/pulumi-genesiscloud",
PluginDownloadURL: "https://github.com/genesiscloud/pulumi-genesiscloud/releases/download/" + Version,
PluginDownloadURL: "github://api.github.com/genesiscloud", //"https://github.com/genesiscloud/pulumi-genesiscloud/releases/download/" + Version,
LogoURL: "https://avatars.githubusercontent.com/u/38134186?s=200&v=4",
Version: Version,
GitHubOrg: "genesiscloud",
MetadataInfo: tfbridge.NewProviderMetadata(metadata),
Expand Down
4 changes: 2 additions & 2 deletions sdk/go/genesiscloud/internal/pulumiUtilities.go

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

2 changes: 1 addition & 1 deletion sdk/go/genesiscloud/pulumi-plugin.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"resource": true,
"name": "genesiscloud",
"server": "https://github.com/genesiscloud/pulumi-genesiscloud/releases/"
"server": "github://api.github.com/genesiscloud"
}
4 changes: 2 additions & 2 deletions sdk/nodejs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"genesiscloud",
"category/cloud"
],
"homepage": "https://www.genesiscloud.com",
"homepage": "https://www.pulumi.io",
"repository": "https://github.com/genesiscloud/pulumi-genesiscloud",
"license": "Apache-2.0",
"scripts": {
Expand All @@ -23,6 +23,6 @@
"pulumi": {
"resource": true,
"name": "genesiscloud",
"server": "https://github.com/genesiscloud/pulumi-genesiscloud/releases/"
"server": "github://api.github.com/genesiscloud"
}
}
2 changes: 1 addition & 1 deletion sdk/nodejs/utilities.ts
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ export function getVersion(): string {

/** @internal */
export function resourceOptsDefaults(): any {
return { version: getVersion(), pluginDownloadURL: "https://github.com/genesiscloud/pulumi-genesiscloud/releases/" };
return { version: getVersion(), pluginDownloadURL: "github://api.github.com/genesiscloud" };
}

/** @internal */
Expand Down
23 changes: 8 additions & 15 deletions sdk/python/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Foo Resource Provider
# Genesis Cloud Resource Provider

The Genesis Cloud Resource Provider lets you manage [Genesis Cloud](http://genesiscloud.com) resources.

Expand All @@ -11,21 +11,21 @@ This package is available for several languages/platforms:
To use from JavaScript or TypeScript in Node.js, install using either `npm`:

```bash
npm install @pulumi/genesiscloud
npm install @genesiscloud/pulumi-genesiscloud
```

or `yarn`:

```bash
yarn add @pulumi/genesiscloud
yarn add @genesiscloud/pulumi-genesiscloud
```

### Python

To use from Python, install using `pip`:

```bash
pip install pulumi_genesiscloud
pip install pulumi-genesiscloud
```

### Go
Expand All @@ -36,20 +36,13 @@ To use from Go, use `go get` to grab the latest version of the library:
go get github.com/genesiscloud/pulumi-genesiscloud/sdk/go/...
```

### .NET
## Configuration

NOTE: Not yet supported.
The following configuration points are available:

To use from .NET, install using `dotnet add package`:

```bash
dotnet add package Pulumi.GenesisCloud
```
- `genesiscloud:token` - (Required) This is the Genesis Cloud API Token, can also be specified with the `GENESISCLOUD_TOKEN` environment variable.
- `genesiscloud:endpoint` - (Optional) Genesis Cloud API endpoint, can be used to override the default API Endpoint `https://api.genesiscloud.com`.

## Reference

For detailed reference documentation, please visit [the Pulumi registry](https://www.pulumi.com/registry/packages/genesiscloud/api-docs/).

## Developing the provider

TODO: add information on how to develop the provider.
2 changes: 1 addition & 1 deletion sdk/python/pulumi_genesiscloud/_utilities.py
Original file line number Diff line number Diff line change
Expand Up @@ -288,4 +288,4 @@ async def _await_output(o: pulumi.Output[typing.Any]) -> typing.Tuple[object, bo
)

def get_plugin_download_url():
return "https://github.com/genesiscloud/pulumi-genesiscloud/releases/"
return "github://api.github.com/genesiscloud"
2 changes: 1 addition & 1 deletion sdk/python/pulumi_genesiscloud/pulumi-plugin.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"resource": true,
"name": "genesiscloud",
"server": "https://github.com/genesiscloud/pulumi-genesiscloud/releases/"
"server": "github://api.github.com/genesiscloud"
}
2 changes: 1 addition & 1 deletion sdk/python/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ def readme():
long_description=readme(),
long_description_content_type='text/markdown',
keywords='pulumi genesiscloud category/cloud',
url='https://www.genesiscloud.com',
url='https://www.pulumi.io',
project_urls={
'Repository': 'https://github.com/genesiscloud/pulumi-genesiscloud'
},
Expand Down

0 comments on commit b0b06fa

Please sign in to comment.