iSharkFly-Docs/Packer-Cn
2
0
Fork 0
mirror of https://github.com/hashicorp/packer.git synced 2026-09-21 23:41:41 -04:00
Code Issues Packages Projects Releases Wiki Activity

Remove reference to deprecated single components

Browse Source
This commit is contained in:
Wilken Rivera
2023-12-06 11:45:07 -05:00
committed by Lucas Bajolet
parent 6cf4e037b5
commit 80e769a117
1 changed files with 1 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files
website/content/docs/plugins/creation/index.mdx
+1 -46
View File
@@ -49,15 +49,7 @@ danger of colliding dependencies.
- [`github.com/hashicorp/packer-plugin-sdk/plugin`](https://pkg.go.dev/github.com/hashicorp/packer-plugin-sdk/plugin) - Contains the code to serve the plugin. This handles all the inter-process communication.
Basic examples of serving your component are shown below. Note that if you
define a multi-component plugin, you can (but do not need to) add more than one
component per plugin binary. The multi-component plugin is also compatible with
download and installation via `packer init`, whereas the single-component plugin
is not.
<Tabs>
<Tab heading="Multi-component Plugin (recommended) ">
Basic examples of serving your component are shown below.
```go
// main.go
@@ -107,43 +99,6 @@ the following components available:
- the `my-foo` post-processor
- the `my-bar` provisioner
</Tab>
<Tab heading="Single Component Plugin (deprecated)">
```go
// main.go
import (
"github.com/hashicorp/packer-plugin-sdk/plugin"
)
// Assume this implements the packer.Builder interface
type Builder struct{}
func main() {
server, err := plugin.Server()
if err != nil {
panic(err)
}
server.RegisterBuilder(new(Builder))
server.Serve()
}
```
This `server.Serve()` invocation handles all the details of communicating with
Packer core and serving your component over RPC. As long as your struct being
registered implements one of the component interfaces, Packer will now be able
to launch your plugin and use it.
Please note that single-component plugins exist for backwards-compatability. We
would rather you register your component using the multi-component method shown
in the other tab, even if you only have one component in your binary. This is
because the `packer init` command only supports multi-component plugins.
</Tab>
</Tabs>
Next, build your plugin as you would any other Go application. The resulting
binary is the plugin that can be installed using
[standard installation procedures](https://developer.hashicorp.com/packer/docs/plugins#installing-plugins).