Anka

[NorseGaud]

Description

We provide builders and a provisioner for our customers to create Anka VM templates/tags with packer.

https://github.com/veertuinc/packer-plugin-veertu-anka

Integration Tier

community

Checklist

• Has valid metadata.hcl file in plugin repository.
• Has added integration scripts packer-plugin-scaffolding to plugin repository.
• Has added top-level integration README.md file to plugin docs directory.
• All plugins components have one README.md describing their usage.
• Has a fully synced .web-docs directory ready for publishing to the integrations portal.

[lbajolet-hashicorp]

Hi @NorseGaud,

Thanks for bringing this up! Looking at the .web-docs directory on the plugin, it looks like the metadata.hcl file is not present?
We won't be able to add the integration if it's not in the expected location, could you add it to your plugin?

If you need an example of a working metadata.hcl file, please take a look at the one from the Amazon plugin for example, and let me know when it's ready to go, I'll take another look at the plugin code then.

Thanks!

[NorseGaud]

Hi @NorseGaud,

Thanks for bringing this up! Looking at the .web-docs directory on the plugin, it looks like the metadata.hcl file is not present?

We won't be able to add the integration if it's not in the expected location, could you add it to your plugin?

If you need an example of a working metadata.hcl file, please take a look at the one from the Amazon plugin for example, and let me know when it's ready to go, I'll take another look at the plugin code then.

Thanks!

Hey @lbajolet-hashicorp your guide says I can put it under the docs folder too. Is that wrong?

[lbajolet-hashicorp]

Oh? I was under the impression that this had to be under .web-docs as this is what the integrations look for, so either I'm missing something or the docs are inaccurate.

I'll dig into it and ask questions around, today's Memorial Day in the US so most of the org is out of office, but hopefully this should resolve itself soon!

[NorseGaud]

I can move it back tomorrow too. No problemo. I just remember it saying somewhere that I had to put it under either directory and docs makes more sense to me.

[lbajolet-hashicorp]

Out-of-curiosity, which docs are you referring to?

[lbajolet-hashicorp]

If it makes more sense to you, and it doesn't conflict with how we are processing the docs, by all means don't feel obligated to move them now, I was under the impression that the .web-docs directory (or whatever the name, it's just where the scripts export the processed docs by default) was the source of truth and everything had to be under it, but maybe there's something we can do to point to the other place.
I'll come back to this thread once I have more information

[NorseGaud]

[lbajolet-hashicorp]

Thanks for the update! I believe this is a phrasing problem then, strictly speaking we don't enforce the name of the output directory as .web-docs, but this is what we default to (it is something we register for a plugin on our internal repository so the service that processes ingestion requests knows where to look).
If you wanted to amend the scripts used to generate those docs, you can change the output to any named directory, and start versioning it.

So in your case, the docs directory is .web-docs, and this is where we expect the metadata.hcl file to be located, as docs is a staging area for docs (at least with the hierarchy we propose in the scaffolding project): this is where the bulk of the contents are written, and where you can import partials in order to weave output markdown files that are then placed into .web-docs under the expected hierarchy/name scheme.

I've asked for a confirmation regarding the metadata.hcl file just to be sure, but I think this is more of a miscommunication on our part than anything else.

I'll try to follow-up as soon as possible regarding this.

[lbajolet-hashicorp]

Hey again @NorseGaud,

I just had confirmation this is a phrasing blunder on our part, I'll try to open a PR to clarify this tomorrow.

With the setup you have, you will need to place the metadata.hcl under .web-docs/metadata.hcl, then we can proceed with the integration PR on our side, then we can sync with you so a release is published once it's in, and the docs for your plugin should appear soon after this.

Thanks in advance!

[NorseGaud]

@lbajolet-hashicorp , ready to roll! Thanks!

[lbajolet-hashicorp]

Hi @NorseGaud,

You should be able to trigger a publish right now I believe, the PR I opened on the internal integrations has been merged, so at this point you should be all set. There might be a delay in the deployments so if it fails for the next couple of hours don't panic, but please do update this issue if you don't see a job succeeding or if the integrations don't show your plugin by tomorrow.

Thanks!

[NorseGaud]

Hey @lbajolet-hashicorp , I've been trying to run it and it's throwing

[validate-hcl]: Running
Error: [validate-hcl] Error: Integration not found for integration identifier: 'packer/veertuinc/veertu-anka'

https://github.com/veertuinc/packer-plugin-veertu-anka/actions/runs/9303310228/job/25605330207

Am I doing something wrong, or did I misconfigure it?

[lbajolet-hashicorp]

Hey @NorseGaud,

Probably something I did wrong, sorry about that! I'll take a look ASAP on our side and keep you posted

[lbajolet-hashicorp]

Hi again @NorseGaud,

We've just merged a change on our side, hopefully this should fix your issue!

As I mentioned earlier, this could take a moment before deployments are processed, but I would think you will be able to trigger a publish soon.

Please let me know how that goes!

[NorseGaud]

Thanks @lbajolet-hashicorp !! I think it worked now. I'll keep checking the integrations page. Can you confirm if it worked from your end?

[NorseGaud]

It's there! Wohooo! Thanks for the help!

[github-actions]

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.