{"payload":{"allShortcutsEnabled":false,"fileTree":{"docs/provisioners":{"items":[{"name":"converge.mdx","path":"docs/provisioners/converge.mdx","contentType":"file"}],"totalCount":1},"docs":{"items":[{"name":"provisioners","path":"docs/provisioners","contentType":"directory"},{"name":"README.md","path":"docs/README.md","contentType":"file"}],"totalCount":2},"":{"items":[{"name":".circleci","path":".circleci","contentType":"directory"},{"name":".github","path":".github","contentType":"directory"},{"name":"docs-partials","path":"docs-partials","contentType":"directory"},{"name":"docs","path":"docs","contentType":"directory"},{"name":"example","path":"example","contentType":"directory"},{"name":"provisioner","path":"provisioner","contentType":"directory"},{"name":"version","path":"version","contentType":"directory"},{"name":".gitignore","path":".gitignore","contentType":"file"},{"name":".golangci.yml","path":".golangci.yml","contentType":"file"},{"name":".goreleaser.yml","path":".goreleaser.yml","contentType":"file"},{"name":"CHANGELOG.md","path":"CHANGELOG.md","contentType":"file"},{"name":"CODEOWNERS","path":"CODEOWNERS","contentType":"file"},{"name":"GNUmakefile","path":"GNUmakefile","contentType":"file"},{"name":"LICENSE","path":"LICENSE","contentType":"file"},{"name":"README.md","path":"README.md","contentType":"file"},{"name":"go.mod","path":"go.mod","contentType":"file"},{"name":"go.sum","path":"go.sum","contentType":"file"},{"name":"main.go","path":"main.go","contentType":"file"}],"totalCount":18}},"fileTreeProcessingTime":14.598333,"foldersToFetch":[],"repo":{"id":358038005,"defaultBranch":"main","name":"packer-plugin-converge","ownerLogin":"hashicorp","currentUserCanPush":false,"isFork":false,"isEmpty":false,"createdAt":"2021-04-14T20:46:11.000Z","ownerAvatar":"https://avatars.githubusercontent.com/u/761456?v=4","public":true,"private":false,"isOrgOwned":true},"symbolsExpanded":false,"treeExpanded":true,"refInfo":{"name":"main","listCacheKey":"v0:1636663460.267094","canEdit":false,"refType":"branch","currentOid":"1d97f40458803e56f1080f970b87107842dedb0f"},"path":"docs/provisioners/converge.mdx","currentUser":null,"blob":{"rawLines":["---","description: >-"," The converge Packer provisioner uses Converge modules to provision the"," machine.","page_title: Converge - Provisioners","nav_title: Converge","---","","# Converge Provisioner","","@include 'provisioners/unmaintained-plugin.mdx'","","Type: `converge`","","The [Converge](http://converge.aster.is) Packer provisioner uses Converge","modules to provision the machine. It uploads module directories to use as","source, or you can use remote modules.","","The provisioner can optionally bootstrap the Converge client/server binary onto","new images.","","## Basic Example","","The example below is fully functional.","","```hcl","provisioner \"converge\" {"," module = \"https://raw.githubusercontent.com/asteris-llc/converge/master/samples/fileContent.hcl\""," prevent_sudo = true"," params = {"," message = \"Hello, Packer!\""," }","}","```","","## Configuration Reference","","The reference of available configuration options is listed below. The only","required element is \"module\". Every other option is optional.","","- `module` (string) - Path (or URL) to the root module that Converge will"," apply.","","Optional parameters:","","- `bootstrap` (boolean, defaults to false) - Set to allow the provisioner to"," download the latest Converge bootstrap script and the specified `version`"," of Converge from the internet.","","- `version` (string) - Set to a [released Converge"," version](https://github.com/asteris-llc/converge/releases) for bootstrap.","","- `module_dirs` (array of directory specifications) - Module directories to"," transfer to the remote host for execution. See below for the specification.","","- `working_directory` (string) - The directory that Converge will change to"," before execution.","","- `params` (maps of string to string) - parameters to pass into the root"," module.","","- `execute_command` (string) - the command used to execute Converge. This is a"," [configuration template variables](/docs/templates/legacy_json_templates/engine)."," See below for detailed usage instructions.","","- `prevent_sudo` (boolean) - stop Converge from running with administrator"," privileges via sudo","","- `bootstrap_command` (string) - the command used to bootstrap Converge. This"," is a [template engine](/docs/templates/legacy_json_templates/engine). Therefore, you may use"," user variables and template functions in this field. The following extra"," variables are also avilable in this engine:",""," - `Version`: The version of Converge to use."," - `Sudo`: Boolean; intended to say whether to use sudo or not.",""," By default, this is `\"curl -s https://get.converge.sh | {{if .Sudo}}sudo {{end}}sh {{if ne .Version \\\"\\\"}}-s -- -v {{.Version}}{{end}}\"`","","- `prevent_bootstrap_sudo` (boolean) - stop Converge from bootstrapping with"," administrator privileges via sudo","","### Module Directories","","The provisioner can transfer module directories to the remote host for","provisioning. Of these fields, `source` and `destination` are required in every","directory.","","- `source` (string) - the path to the folder on the local machine.","","- `destination` (string) - the path to the folder on the remote machine."," Parent directories will not be created; use the shell module to do this.","","- `exclude` (array of string) - files and directories to exclude from"," transfer.","","### Execute Command","","By default, Packer uses the following command (broken across multiple lines for","readability) to execute Converge:","","```liquid","cd {{.WorkingDirectory}} && \\","{{if .Sudo}}sudo {{end}}converge apply \\"," --local \\"," --log-level=WARNING \\"," --paramsJSON '{{.ParamsJSON}}' \\"," {{.Module}}","```","","This command can be customized using the `execute_command` configuration. As","you can see from the default value above, the value of this configuration can","contain various template variables:","","- `WorkingDirectory` - `directory` from the configuration.","- `Sudo` - the opposite of `prevent_sudo` from the configuration.","- `ParamsJSON` - The unquoted JSONified form of `params` from the"," configuration.","- `Module` - `module` from the configuration.","","### Bootstrap Command","","By default, Packer uses the following command to bootstrap Converge:","","```liquid","curl -s https://get.converge.sh | {{if .Sudo}}sudo {{end}}sh {{if ne .Version \"\"}}-s -- -v {{.Version}}{{end}}","```","","This command can be customized using the `bootstrap_command` configuration. As","you can see from the default values above, the value of this configuration can","contain various template variables:","","- `Sudo` - the opposite of `prevent_bootstrap_sudo` from the configuration.","- `Version` - `version` from the configuration."],"stylingDirectives":[[{"start":0,"end":3,"cssClass":"pl-s"}],[{"start":0,"end":11,"cssClass":"pl-ent"},{"start":13,"end":15,"cssClass":"pl-s"}],[{"start":0,"end":72,"cssClass":"pl-s"}],[{"start":0,"end":10,"cssClass":"pl-s"}],[{"start":0,"end":0,"cssClass":"pl-s"},{"start":0,"end":10,"cssClass":"pl-ent"},{"start":12,"end":35,"cssClass":"pl-s"}],[{"start":0,"end":9,"cssClass":"pl-ent"},{"start":11,"end":19,"cssClass":"pl-s"}],[{"start":0,"end":3,"cssClass":"pl-s"}],[],[{"start":0,"end":22,"cssClass":"pl-mh"},{"start":2,"end":22,"cssClass":"pl-en"}],[],[{"start":0,"end":8,"cssClass":"pl-s"},{"start":1,"end":8,"cssClass":"pl-corl"}],[],[{"start":6,"end":7,"cssClass":"pl-s"},{"start":7,"end":15,"cssClass":"pl-c1"},{"start":15,"end":16,"cssClass":"pl-s"}],[],[{"start":4,"end":5,"cssClass":"pl-s"},{"start":13,"end":14,"cssClass":"pl-s"},{"start":14,"end":15,"cssClass":"pl-s"},{"start":15,"end":39,"cssClass":"pl-corl"},{"start":39,"end":40,"cssClass":"pl-s"}],[],[],[],[],[],[],[{"start":0,"end":16,"cssClass":"pl-mh"},{"start":3,"end":16,"cssClass":"pl-en"}],[],[],[],[{"start":0,"end":3,"cssClass":"pl-s"},{"start":3,"end":6,"cssClass":"pl-en"},{"start":6,"end":6,"cssClass":"pl-c1"}],[{"start":0,"end":24,"cssClass":"pl-c1"}],[{"start":0,"end":98,"cssClass":"pl-c1"}],[{"start":0,"end":21,"cssClass":"pl-c1"}],[{"start":0,"end":12,"cssClass":"pl-c1"}],[{"start":0,"end":30,"cssClass":"pl-c1"}],[{"start":0,"end":3,"cssClass":"pl-c1"}],[{"start":0,"end":1,"cssClass":"pl-c1"}],[{"start":0,"end":0,"cssClass":"pl-c1"},{"start":0,"end":3,"cssClass":"pl-s"}],[],[{"start":0,"end":26,"cssClass":"pl-mh"},{"start":3,"end":26,"cssClass":"pl-en"}],[],[],[],[],[{"start":0,"end":1,"cssClass":"pl-v"},{"start":2,"end":3,"cssClass":"pl-s"},{"start":3,"end":9,"cssClass":"pl-c1"},{"start":9,"end":10,"cssClass":"pl-s"}],[],[],[],[],[{"start":0,"end":1,"cssClass":"pl-v"},{"start":2,"end":3,"cssClass":"pl-s"},{"start":3,"end":12,"cssClass":"pl-c1"},{"start":12,"end":13,"cssClass":"pl-s"}],[{"start":66,"end":67,"cssClass":"pl-s"},{"start":67,"end":74,"cssClass":"pl-c1"},{"start":74,"end":75,"cssClass":"pl-s"}],[],[],[{"start":0,"end":1,"cssClass":"pl-v"},{"start":2,"end":3,"cssClass":"pl-s"},{"start":3,"end":10,"cssClass":"pl-c1"},{"start":10,"end":11,"cssClass":"pl-s"},{"start":32,"end":33,"cssClass":"pl-s"}],[{"start":9,"end":10,"cssClass":"pl-s"},{"start":10,"end":11,"cssClass":"pl-s"},{"start":11,"end":59,"cssClass":"pl-corl"},{"start":59,"end":60,"cssClass":"pl-s"}],[],[{"start":0,"end":1,"cssClass":"pl-v"},{"start":2,"end":3,"cssClass":"pl-s"},{"start":3,"end":14,"cssClass":"pl-c1"},{"start":14,"end":15,"cssClass":"pl-s"}],[],[],[{"start":0,"end":1,"cssClass":"pl-v"},{"start":2,"end":3,"cssClass":"pl-s"},{"start":3,"end":20,"cssClass":"pl-c1"},{"start":20,"end":21,"cssClass":"pl-s"}],[],[],[{"start":0,"end":1,"cssClass":"pl-v"},{"start":2,"end":3,"cssClass":"pl-s"},{"start":3,"end":9,"cssClass":"pl-c1"},{"start":9,"end":10,"cssClass":"pl-s"}],[],[],[{"start":0,"end":1,"cssClass":"pl-v"},{"start":2,"end":3,"cssClass":"pl-s"},{"start":3,"end":18,"cssClass":"pl-c1"},{"start":18,"end":19,"cssClass":"pl-s"}],[{"start":2,"end":3,"cssClass":"pl-s"},{"start":35,"end":36,"cssClass":"pl-s"},{"start":36,"end":37,"cssClass":"pl-s"},{"start":37,"end":81,"cssClass":"pl-corl"},{"start":81,"end":82,"cssClass":"pl-s"}],[],[],[{"start":0,"end":1,"cssClass":"pl-v"},{"start":2,"end":3,"cssClass":"pl-s"},{"start":3,"end":15,"cssClass":"pl-c1"},{"start":15,"end":16,"cssClass":"pl-s"}],[],[],[{"start":0,"end":1,"cssClass":"pl-v"},{"start":2,"end":3,"cssClass":"pl-s"},{"start":3,"end":20,"cssClass":"pl-c1"},{"start":20,"end":21,"cssClass":"pl-s"}],[{"start":7,"end":8,"cssClass":"pl-s"},{"start":23,"end":24,"cssClass":"pl-s"},{"start":24,"end":25,"cssClass":"pl-s"},{"start":25,"end":69,"cssClass":"pl-corl"},{"start":69,"end":70,"cssClass":"pl-s"}],[],[],[],[{"start":2,"end":3,"cssClass":"pl-v"},{"start":4,"end":5,"cssClass":"pl-s"},{"start":5,"end":12,"cssClass":"pl-c1"},{"start":12,"end":13,"cssClass":"pl-s"}],[{"start":2,"end":3,"cssClass":"pl-v"},{"start":4,"end":5,"cssClass":"pl-s"},{"start":5,"end":9,"cssClass":"pl-c1"},{"start":9,"end":10,"cssClass":"pl-s"}],[],[{"start":22,"end":23,"cssClass":"pl-s"},{"start":23,"end":137,"cssClass":"pl-c1"},{"start":137,"end":138,"cssClass":"pl-s"}],[],[{"start":0,"end":1,"cssClass":"pl-v"},{"start":2,"end":3,"cssClass":"pl-s"},{"start":3,"end":25,"cssClass":"pl-c1"},{"start":25,"end":26,"cssClass":"pl-s"}],[],[],[{"start":0,"end":22,"cssClass":"pl-mh"},{"start":4,"end":22,"cssClass":"pl-en"}],[],[],[{"start":31,"end":32,"cssClass":"pl-s"},{"start":32,"end":38,"cssClass":"pl-c1"},{"start":38,"end":39,"cssClass":"pl-s"},{"start":44,"end":45,"cssClass":"pl-s"},{"start":45,"end":56,"cssClass":"pl-c1"},{"start":56,"end":57,"cssClass":"pl-s"}],[],[],[{"start":0,"end":1,"cssClass":"pl-v"},{"start":2,"end":3,"cssClass":"pl-s"},{"start":3,"end":9,"cssClass":"pl-c1"},{"start":9,"end":10,"cssClass":"pl-s"}],[],[{"start":0,"end":1,"cssClass":"pl-v"},{"start":2,"end":3,"cssClass":"pl-s"},{"start":3,"end":14,"cssClass":"pl-c1"},{"start":14,"end":15,"cssClass":"pl-s"}],[],[],[{"start":0,"end":1,"cssClass":"pl-v"},{"start":2,"end":3,"cssClass":"pl-s"},{"start":3,"end":10,"cssClass":"pl-c1"},{"start":10,"end":11,"cssClass":"pl-s"}],[],[],[{"start":0,"end":19,"cssClass":"pl-mh"},{"start":4,"end":19,"cssClass":"pl-en"}],[],[],[],[],[{"start":0,"end":3,"cssClass":"pl-s"},{"start":3,"end":9,"cssClass":"pl-en"},{"start":9,"end":9,"cssClass":"pl-c1"}],[{"start":0,"end":29,"cssClass":"pl-c1"}],[{"start":0,"end":40,"cssClass":"pl-c1"}],[{"start":0,"end":11,"cssClass":"pl-c1"}],[{"start":0,"end":23,"cssClass":"pl-c1"}],[{"start":0,"end":34,"cssClass":"pl-c1"}],[{"start":0,"end":13,"cssClass":"pl-c1"}],[{"start":0,"end":0,"cssClass":"pl-c1"},{"start":0,"end":3,"cssClass":"pl-s"}],[],[{"start":41,"end":42,"cssClass":"pl-s"},{"start":42,"end":57,"cssClass":"pl-c1"},{"start":57,"end":58,"cssClass":"pl-s"}],[],[],[],[{"start":0,"end":1,"cssClass":"pl-v"},{"start":2,"end":3,"cssClass":"pl-s"},{"start":3,"end":19,"cssClass":"pl-c1"},{"start":19,"end":20,"cssClass":"pl-s"},{"start":23,"end":24,"cssClass":"pl-s"},{"start":24,"end":33,"cssClass":"pl-c1"},{"start":33,"end":34,"cssClass":"pl-s"}],[{"start":0,"end":1,"cssClass":"pl-v"},{"start":2,"end":3,"cssClass":"pl-s"},{"start":3,"end":7,"cssClass":"pl-c1"},{"start":7,"end":8,"cssClass":"pl-s"},{"start":27,"end":28,"cssClass":"pl-s"},{"start":28,"end":40,"cssClass":"pl-c1"},{"start":40,"end":41,"cssClass":"pl-s"}],[{"start":0,"end":1,"cssClass":"pl-v"},{"start":2,"end":3,"cssClass":"pl-s"},{"start":3,"end":13,"cssClass":"pl-c1"},{"start":13,"end":14,"cssClass":"pl-s"},{"start":48,"end":49,"cssClass":"pl-s"},{"start":49,"end":55,"cssClass":"pl-c1"},{"start":55,"end":56,"cssClass":"pl-s"}],[],[{"start":0,"end":1,"cssClass":"pl-v"},{"start":2,"end":3,"cssClass":"pl-s"},{"start":3,"end":9,"cssClass":"pl-c1"},{"start":9,"end":10,"cssClass":"pl-s"},{"start":13,"end":14,"cssClass":"pl-s"},{"start":14,"end":20,"cssClass":"pl-c1"},{"start":20,"end":21,"cssClass":"pl-s"}],[],[{"start":0,"end":21,"cssClass":"pl-mh"},{"start":4,"end":21,"cssClass":"pl-en"}],[],[],[],[{"start":0,"end":3,"cssClass":"pl-s"},{"start":3,"end":9,"cssClass":"pl-en"},{"start":9,"end":9,"cssClass":"pl-c1"}],[{"start":0,"end":110,"cssClass":"pl-c1"}],[{"start":0,"end":0,"cssClass":"pl-c1"},{"start":0,"end":3,"cssClass":"pl-s"}],[],[{"start":41,"end":42,"cssClass":"pl-s"},{"start":42,"end":59,"cssClass":"pl-c1"},{"start":59,"end":60,"cssClass":"pl-s"}],[],[],[],[{"start":0,"end":1,"cssClass":"pl-v"},{"start":2,"end":3,"cssClass":"pl-s"},{"start":3,"end":7,"cssClass":"pl-c1"},{"start":7,"end":8,"cssClass":"pl-s"},{"start":27,"end":28,"cssClass":"pl-s"},{"start":28,"end":50,"cssClass":"pl-c1"},{"start":50,"end":51,"cssClass":"pl-s"}],[{"start":0,"end":1,"cssClass":"pl-v"},{"start":2,"end":3,"cssClass":"pl-s"},{"start":3,"end":10,"cssClass":"pl-c1"},{"start":10,"end":11,"cssClass":"pl-s"},{"start":14,"end":15,"cssClass":"pl-s"},{"start":15,"end":22,"cssClass":"pl-c1"},{"start":22,"end":23,"cssClass":"pl-s"}]],"colorizedLines":null,"csv":null,"csvError":null,"dependabotInfo":{"showConfigurationBanner":false,"configFilePath":null,"networkDependabotPath":"/hashicorp/packer-plugin-converge/network/updates","dismissConfigurationNoticePath":"/settings/dismiss-notice/dependabot_configuration_notice","configurationNoticeDismissed":null},"displayName":"converge.mdx","displayUrl":"https://github.com/hashicorp/packer-plugin-converge/blob/main/docs/provisioners/converge.mdx?raw=true","headerInfo":{"blobSize":"4.37 KB","deleteTooltip":"You must be signed in to make or propose changes","editTooltip":"You must be signed in to make or propose changes","ghDesktopPath":"https://desktop.github.com","isGitLfs":false,"onBranch":true,"shortPath":"e43aef4","siteNavLoginPath":"/login?return_to=https%3A%2F%2Fgithub.com%2Fhashicorp%2Fpacker-plugin-converge%2Fblob%2Fmain%2Fdocs%2Fprovisioners%2Fconverge.mdx","isCSV":false,"isRichtext":false,"toc":null,"lineInfo":{"truncatedLoc":"133","truncatedSloc":"95"},"mode":"file"},"image":false,"isCodeownersFile":null,"isPlain":false,"isValidLegacyIssueTemplate":false,"issueTemplate":null,"discussionTemplate":null,"language":"MDX","languageID":512838272,"large":false,"planSupportInfo":{"repoIsFork":null,"repoOwnedByCurrentUser":null,"requestFullPath":"/hashicorp/packer-plugin-converge/blob/main/docs/provisioners/converge.mdx","showFreeOrgGatedFeatureMessage":null,"showPlanSupportBanner":null,"upgradeDataAttributes":null,"upgradePath":null},"publishBannersInfo":{"dismissActionNoticePath":"/settings/dismiss-notice/publish_action_from_dockerfile","releasePath":"/hashicorp/packer-plugin-converge/releases/new?marketplace=true","showPublishActionBanner":false},"rawBlobUrl":"https://github.com/hashicorp/packer-plugin-converge/raw/main/docs/provisioners/converge.mdx","renderImageOrRaw":false,"richText":null,"renderedFileInfo":null,"shortPath":null,"symbolsEnabled":true,"tabSize":8,"topBannersInfo":{"overridingGlobalFundingFile":false,"globalPreferredFundingPath":null,"showInvalidCitationWarning":false,"citationHelpUrl":"https://docs.github.com/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-citation-files","actionsOnboardingTip":null},"truncated":false,"viewable":true,"workflowRedirectUrl":null,"symbols":{"timed_out":false,"not_analyzed":true,"symbols":[]}},"copilotInfo":null,"copilotAccessAllowed":false,"csrf_tokens":{"/hashicorp/packer-plugin-converge/branches":{"post":"9K47DN5QOX8NcuWoHVH7E8kH3oq-ZP_W0P2mQ_CXPBG7Xh8OVEwmPTh8bP4KLnhe-zawXNUtmmCO4Oz-GfU6Ng"},"/repos/preferences":{"post":"gw7dSFgzDg65Aa5O297qR8MaWc3MLVJNROarCa_mLMog75VdRdCC1-OFAA_AgxEOZO924-RP-1a8gNeB-uFH1g"}}},"title":"packer-plugin-converge/docs/provisioners/converge.mdx at main ยท hashicorp/packer-plugin-converge"}