Add provider documentation to official Terraform documentation about terraform-provider-aiven

[ivan-savciuc]

Finally, Aiven Terraform provider is available on Terraform Registry https://registry.terraform.io/providers/aiven/aiven/latest. Documentation thought is a little bit off, and we will be working in the next days to make it compatible with the Registry format .

[ivan-savciuc]

Hi,

We are planning to spend some time soon, enhancing our documentation for this project. What is the area where we need to put extra attention?

Worth mentioning that Aiven Terraform provider is not yet officially supported by Terraform, and we are planning to apply to Terraform Provider Development Programm https://www.terraform.io/guides/terraform-provider-development-program.html in Q1 2020. When the review process will be completed, and Aiven Terraform is under Terraform GitHub, all Aiven documentation automatically will be embedded in the primary Terraform documentation.

We are working right now to deliver new features and to increase tests code coverage, which is prerequisite for Terraform Provider Development Programm.

Ivan

[jeff-knurek]

I can add my thoughts on the existing documentation having just come into the project and trying to import our existing infra into terraform. In general the content of the readme was good enough.

1. clear separation of arguments vs attributes. For example, with aiven_service, the service_name and service_(uri|host|port|username|password). That's just one example, but going through the list to find what to add to the resource, and what to use in other resources was time consuming.
2. the resource aiven_vpc_peering_connection, the arguments don't align with the "naming" of values in UI for Google project, making it confusing on what is needed to import.
3. aiven_project -> billing_emails, technical_emails, billing_address, country_code there's no documentation on these, and I think they should be managed in a different resource. The workaround of lifecycle { ignore_changes } is suitable, but it was very unexpected when importing. (learned the better workaround is to use data type instead of resource)
4. adding just a simple prometheus service integration is quite complex and un-intuitive with needing both aiven_service_integration_endpoint and aiven_service_integration (and then most integration types aren't supported: ie prometheus)

---

we are planning to apply to Terraform Provider Development Programm... in Q1 2020.

is there a way to track the application to be officially supported by Terraform?
as in, is there somewhere to subscribe to get notified if/when that becomes approved?

[juniorz]

@ivan-savciuc you don't need anymore. I just published it under my username: https://registry.terraform.io/providers/juniorz/aiven/latest

You just need to follow the doc (https://www.terraform.io/docs/registry/providers/publishing.html) which will guide you through some infra changes (juniorz/terraform-provider-aiven@7a40821).

[mveroone]

That's good to hear !
We've investing a lot on Aiven here, but it is critical to us that all deployed infrastructure is done through Terraform for scaling reasons, and the provider is a bit sub-par at the moment, with the documentation being one of its weaknesses.

[gfarand]

Hi Ivan,

Thank for replying so quickly. I am particularly interested in the aiven_service resource, but really all of them would be useful.

[ivan-savciuc]

Hi,

Unfortunately, we haven't applied yet for Terraform Provider Development Programm, a couple of features still blocks us: Account Authentication support #171 (waiting for upcoming release) and migration to SDK #197. When these two will be released, we will start this process, and I will keep you posted here regarding the progress.

[juniorz]

My intention was absolutely not to fork, but rather make a point that it's a self-service and straightforward process.

[mveroone]

How come this issue has not received any answer from Aiven dev team in over 6 month ? I thought the provider was officially supported.

[rikonen]

It is officially supported but we haven't recently been able to devote much time on non-critical work on the provider. That will hopefully change soon.

[gfarand]

Any updates on this subject ? The provider would be infinitely easier to use were it exhaustively documented...

[harshal-shah]

Hi Ivan,
Just wanted to know if there are any updates on the provider being officially supported by terraform?

[phumberdroz]

Hey is this still planned?

Also this seems to be a thing now from the 0.13 release notes.
Automatic installation of third-party providers: Terraform now supports a decentralized namespace for providers, allowing for automatic installation of community providers from third-party namespaces in the public registry and from private registries. (More details will be added about this prior to release.)
https://www.terraform.io/docs/configuration/provider-requirements.html

[ivan-savciuc]

Hey,

Yes, it is planned, we apply for Terraform Development Program straight after we release v2 which will use v0.12.

And indeed it is a nice feature that you've mentioned that we will support soon.

[juniorz]

Are you planning to publish the provider to https://registry.terraform.io/ ? I believe you can publish right from the UI.

[ivan-savciuc]

@juniorz yes, but first we have to go through HashiCorp verification process https://www.terraform.io/guides/terraform-provider-development-program.html

[FlxPeters]

Any updates on when the provider will be available on the Terraform registry? Thx to @juniorz for the fork, but we would prefer to use the official one.

[ivan-savciuc]

We are waiting for a go from Aiven InfoSec team, regarding GPG keys with which we will publish/sign the binaries.

[cordovinian]

@juniorz appreciate the proof of concept!
@ivan-savciuc Is there an updated timeline on when Aiven will import to the official registry?

[bkamin29]

We are waiting for a go from Aiven InfoSec team, regarding GPG keys with which we will publish/sign the binaries.

Hello @ivan-savciuc,
Why not try to use the fast process offered by terraform registry + 0.13 ?
It seems very easy to publish a third party provider with this new process, offered by terraform and his new terraform registry.

[ivan-savciuc]

@ivan-savciuc you don't need anymore. I just published it under my username: https://registry.terraform.io/providers/juniorz/aiven/latest

You just need to follow the doc (https://www.terraform.io/docs/registry/providers/publishing.html) which will guide you through some infra changes (juniorz@7a40821).

Would you be so kind taking down your fork of Aiven Terraform Provider from the registry? So it would not cause any confusion for the customers.