Skip to content

Conversation

volc-engine
Copy link

Volcengine is the cloud services platform of ByteDance. It brings to external customers the growth methodologies, technical capabilities, and tools that powered ByteDance’s rapid development. Volcengine provides cloud infrastructure, video and content delivery, digital intelligence (VeDI), artificial intelligence, development, and operations services to help enterprises accelerate digital transformation and achieve sustainable growth.

Volcenginecc is a Pulumi provider built on Volcengine’s Cloud Control API, enabling developers to manage Volcengine resources safely and consistently through infrastructure as code.

@volc-engine volc-engine requested a review from a team as a code owner September 25, 2025 07:40
@volc-engine
Copy link
Author

  • Pulumi has appropriate contact information from the provider maintainer

    If the provider is community maintained (maintained by a person, not a company), then a GitHub handle is sufficient

    If the provider is maintained by a company, Pulumi needs a contact person at the maintaining company.

  • The package will generate accurate documentation:

    1. Check out the PR under review and run:
    $ make bin/resourcedocsgen
    $ ./bin/resourcedocsgen metadata from-github \
            --repoSlug '<repoSlug>' \
            --schemaFile '<schemaFile>' \
            --version '<version>'

    Here <repoSlug> and <schemaFile> should match exactly the values added to /community-packages/package-list.json.

    This will generate metadata for the provider locally.

    1. Push the metadata files into a PR (either back to the PR under review or a new PR).

    After pushing the provider to CI and waiting for a preview site:

    • Confirm that that CI passes for the PR with the metadata files.

    • Click through the site preview and confirm that the docs (for the new provider) render as expected.

    • The registry renders a valid logo for the new provider.

  • Hand-written docs are complete and accurate:

    • Validate that you can install the new provider with the instructions found in /docs/installation-configuration.md.

    Maintainers should run the pulumi plugin install resource <name> <version> --server <pluginDownloadURL> command specified in the /docs/installation-configuration.md and see a provider be downloaded.

    • /docs/installation-configuration.md contains a link to the published SDK in each language (i.e. TypeScript, Python, Go and C#).

    • /docs/_index.md contains a minimal example in every supported language.

    • /docs/_index.md contains a brief explanation of what the package does.

  • There is a published version:

    • The repository has a version tag prefixed with v that corresponds with a valid GitHub release
    • Each published SDK has a matching release
  • A CODEOWNER has approved the PR.

Adding the package

@dschaller
Copy link
Member

dschaller commented Sep 25, 2025

@volc-engine it looks like there is already an existing pulumi provider for volcengine (https://github.com/volcengine/pulumi-volcengine). Can you explain the difference here?

@volc-engine
Copy link
Author

@dschaller
The pulumi-volcengine provider is also developed by our team. It is based on terraform-provider-volcengine, which was implemented manually.

We are now using terraform-provider-volcenginecc, which is built on top of the Volcengine Cloud Control API. Since this approach is more standardized and future-proof, we plan to make pulumi-volcenginecc (bridged from terraform-provider-volcenginecc) our primary provider going forward.

@dschaller
Copy link
Member

Thanks for explaining @volc-engine. Should the existing volcengine provider be marked as deprecated then?

Also, would you mind filling out this google form

@volc-engine
Copy link
Author

@dschaller We don’t plan to deprecate the old version in the short term. In the longer run, however, we encourage users to use the newer Pulumicc package

@volc-engine
Copy link
Author

@dschaller We haved filled out the form

@dschaller
Copy link
Member

Thanks @volc-engine! Is it possible to add some kind of documentation in the overview on what the difference is for volcenginecc? The overviews are pretty similar so it might not be clear as a user which one to pick

http://registry--origin-pr-8724-d71a8460.s3-website.us-west-2.amazonaws.com/registry/packages/volcenginecc/
http://registry--origin-pr-8724-d71a8460.s3-website.us-west-2.amazonaws.com/registry/packages/volcengine/

@volc-engine
Copy link
Author

@dschaller I’ve already updated index.md and added the Volcengine and VolcengineCC sections.
If there are any other areas that need to be updated or supplemented, please let me know — I’ll address them all at once as soon as possible.

@volc-engine
Copy link
Author

@dschaller
Thanks again for the review. Please let me know if there’s anything else we should provide (e.g., extra examples, docs tweaks, schema updates, release notes, or CI logs).

When you have a moment, could you also share an estimated timeline for publishing this to the Pulumi Registry? Even a rough estimate would help us plan downstream work.

Happy to make any quick fixes on our side—just point us to what’s missing. Thanks!

@dschaller
Copy link
Member

Thanks @volc-engine! Regenerated the docs on my branch and will let you know when it's done building.

@dschaller
Copy link
Member

Thanks for the updates @volc-engine! Looks good, merging the provider on this branch since we can't run CI from forks.

@dschaller dschaller closed this Oct 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants