Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(registry): Add pgEdge provider package #6023

Open
wants to merge 10 commits into
base: master
Choose a base branch
from

Conversation

KnockOutEZ
Copy link

Description

This PR adds the pgEdge provider package to the Pulumi Registry. The pgEdge provider enables management of pgEdge Cloud resources, supporting both Developer and Enterprise editions. This provider allows users to manage databases, clusters, backup stores, and cloud accounts through Pulumi infrastructure as code.

Adding a new package?

If this pull request adds a new package:

  • The package's schema URL in this PR is correct (provider/cmd/pulumi-resource-pgedge/schema.json).
  • The package metadata file contains:
  • The package repo contains an Overview doc (/docs/_index.md) that includes:
    • a brief explanation of the pgEdge provider and its capabilities.
    • representative examples in TypeScript and Go.
    • front-matter layout property set to package.
  • The package repo contains an Installation and Configuration doc (/docs/installation-configuration.md) that includes:
    • links to Node.js and Go SDKs.
    • installation commands for npm/yarn and go get.
    • configuration examples using environment variables (PGEDGE_CLIENT_ID and PGEDGE_CLIENT_SECRET).
  • The repository has:
    • version tag v0.0.28 with corresponding GitHub release
  • A CODEOWNER has reviewed the PR.
  • A member of the @pulumi/docs team has reviewed all documentation.

Additional Notes:

  • Package is currently in public preview status
  • Supports both Developer and Enterprise editions with different feature sets
  • Includes comprehensive support for database, cluster, and backup management
  • Provides multi-region deployment capabilities

@iwahbe iwahbe added the needs-triage Needs attention from the triage team label Nov 19, 2024
Copy link
Member

@iwahbe iwahbe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @KnockOutEZ, thanks for opening a PR and writing such great docs. We will need to make a couple of changes before merging.

@@ -189,6 +190,7 @@ var TitleLookup = map[string]string{
"opsgenie": "Opsgenie",
"packet": "Packet",
"pagerduty": "PagerDuty",
"pgedge": "pgEdge",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TitleLookup is being deprecated in favor of the "displayName" field in the provider schema. If you set tfbridge.ProviderInfo.DisplayName, then it will flow through.

We are not adding new packages to lookup.go.

@@ -92,6 +92,7 @@ var CategoryLookup = map[string]PackageCategory{
"openstack": PackageCategoryCloud,
"opsgenie": PackageCategoryInfrastructure,
"pagerduty": PackageCategoryInfrastructure,
"pgedge": PackageCategoryDatabase,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of setting this in the override map, please just set catagory/database in your schemas "keywords" section with tfbridge.ProviderInfo.Keywords.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file is auto-generated, and will be added automatically.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs files are pulled from your repo. This file should live at github.com/pgedge/pulumi-pgedge/docs/_index.md. The registry will pick it up during builds.

This way the docs are:

  1. Versioned with your provider.
  2. Editable by you without going through our PR process.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs files are pulled from your repo. This file should live at github.com/pgedge/pulumi-pgedge/docs/installation-configuration.md. The registry will pick it up during builds.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the only change we need here.

@KnockOutEZ KnockOutEZ requested a review from a team as a code owner November 20, 2024 20:15
@KnockOutEZ
Copy link
Author

Thanks for the feedbacks @iwahbe . I just fixed the PR items and also updated the pulumi-pgedge repo.

@mjeffryes
Copy link
Member

mjeffryes commented Nov 20, 2024

Thanks for the contribution @KnockOutEZ. A few questions:

  • Our partnerships team likes to maintain an email contact for a maintainer on contributed providers. Can you share a contact to represent pgEdge as a maintainer of this provider?
  • Our policy is generally to wait until all Pulumi languages are supported before publishing in our registry, but I noticed that support for python and dotnet SDKs are listed as coming soon. Can you please publish SDKs to PyPi and Nuget and update examples in your index and configuration docs to match?

@mjeffryes mjeffryes added awaiting-feedback Blocked on input from the author and removed needs-triage Needs attention from the triage team labels Nov 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting-feedback Blocked on input from the author
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants