diff --git a/builder/alicloud/ecs/image_config.go b/builder/alicloud/ecs/image_config.go index 76315e833..dd1169f4e 100644 --- a/builder/alicloud/ecs/image_config.go +++ b/builder/alicloud/ecs/image_config.go @@ -171,13 +171,13 @@ type AlicloudImageConfig struct { // images and then create the target images, otherwise, the creation will // fail. The default value is false. Check `image_name` and // `image_copy_names` options for names of target images. If - // [-force](https://packer.io/docs/commands/build.html#force) option is + // [-force](https://packer.io/docs/commands/build#force) option is // provided in `build` command, this option can be omitted and taken as // true. AlicloudImageForceDelete bool `mapstructure:"image_force_delete" required:"false"` // If this value is true, when delete the duplicated existing images, the // source snapshots of those images will be delete either. If - // [-force](https://packer.io/docs/commands/build.html#force) option is + // [-force](https://packer.io/docs/commands/build#force) option is // provided in `build` command, this option can be omitted and taken as // true. AlicloudImageForceDeleteSnapshots bool `mapstructure:"image_force_delete_snapshots" required:"false"` @@ -194,7 +194,7 @@ type AlicloudImageConfig struct { AlicloudImageTags map[string]string `mapstructure:"tags" required:"false"` // Same as [`tags`](#tags) but defined as a singular repeatable block // containing a `name` and a `value` field. In HCL2 mode the - // [`dynamic_block`](https://packer.io/docs/configuration/from-1.5/expressions.html#dynamic-blocks) + // [`dynamic_block`](https://packer.io/docs/configuration/from-1.5/expressions#dynamic-blocks) // will allow you to create those programatically. AlicloudImageTag hcl2template.NameValues `mapstructure:"tag" required:"false"` AlicloudDiskDevices `mapstructure:",squash"` diff --git a/builder/amazon/chroot/builder.go b/builder/amazon/chroot/builder.go index 035dc5a3d..c7d413f0e 100644 --- a/builder/amazon/chroot/builder.go +++ b/builder/amazon/chroot/builder.go @@ -161,12 +161,12 @@ type Config struct { //filter, but will cause Packer to fail if the `source_ami` does not exist. SourceAmiFilter awscommon.AmiFilterOptions `mapstructure:"source_ami_filter" required:"false"` // Tags to apply to the volumes that are *launched*. This is a [template - // engine](/docs/templates/engine.html), see [Build template + // engine](https://packer.io/docs/templates/engine), see [Build template // data](#build-template-data) for more information. RootVolumeTags map[string]string `mapstructure:"root_volume_tags" required:"false"` // Same as [`root_volume_tags`](#root_volume_tags) but defined as a // singular block containing a `name` and a `value` field. In HCL2 mode the - // [`dynamic_block`](https://packer.io/docs/configuration/from-1.5/expressions.html#dynamic-blocks) + // [`dynamic_block`](https://packer.io/docs/configuration/from-1.5/expressions#dynamic-blocks) // will allow you to create those programatically. RootVolumeTag hcl2template.NameValues `mapstructure:"root_volume_tag" required:"false"` // what architecture to use when registering the final AMI; valid options diff --git a/builder/amazon/common/access_config.go b/builder/amazon/common/access_config.go index 9e158f224..5305890ff 100644 --- a/builder/amazon/common/access_config.go +++ b/builder/amazon/common/access_config.go @@ -44,7 +44,7 @@ func (v *VaultAWSEngineOptions) Empty() bool { // AccessConfig is for common configuration related to AWS access type AccessConfig struct { // The access key used to communicate with AWS. [Learn how to set this] - // (/docs/builders/amazon.html#specifying-amazon-credentials). On EBS, this + // (https://packer.io/docs/builders/amazon#specifying-amazon-credentials). On EBS, this // is not required if you are using `use_vault_aws_engine` for // authentication instead. AccessKey string `mapstructure:"access_key" required:"true"` @@ -79,7 +79,7 @@ type AccessConfig struct { // When chroot building, this value is guessed from environment. RawRegion string `mapstructure:"region" required:"true"` // The secret key used to communicate with AWS. [Learn how to set - // this](amazon.html#specifying-amazon-credentials). This is not required + // this](https://packer.io/docs/builders/amazon#specifying-amazon-credentials). This is not required // if you are using `use_vault_aws_engine` for authentication instead. SecretKey string `mapstructure:"secret_key" required:"true"` // Set to true if you want to skip @@ -95,7 +95,7 @@ type AccessConfig struct { // Get credentials from Hashicorp Vault's aws secrets engine. You must // already have created a role to use. For more information about // generating credentials via the Vault engine, see the [Vault - // docs.](https://www.vaultproject.io/api/secret/aws/index.html#generate-credentials) + // docs.](https://www.vaultproject.io/api/secret/aws#generate-credentials) // If you set this flag, you must also set the below options: // - `name` (string) - Required. Specifies the name of the role to generate // credentials against. This is part of the request URL. @@ -190,7 +190,7 @@ func (c *AccessConfig) Session() (*session.Session, error) { if isAWSErr(err, "NoCredentialProviders", "") { return nil, fmt.Errorf("No valid credential sources found for AWS Builder. " + - "Please see https://www.packer.io/docs/builders/amazon.html#specifying-amazon-credentials " + + "Please see https://www.packer.io/docs/builders/amazon#specifying-amazon-credentials " + "for more information on providing credentials for the AWS Builder.") } diff --git a/builder/amazon/common/ami_config.go b/builder/amazon/common/ami_config.go index 8d421e453..c0b3ef9ff 100644 --- a/builder/amazon/common/ami_config.go +++ b/builder/amazon/common/ami_config.go @@ -17,11 +17,11 @@ type AMIConfig struct { // The name of the resulting AMI that will appear when managing AMIs in the // AWS console or via APIs. This must be unique. To help make this unique, // use a function like timestamp (see [template - // engine](../templates/engine.html) for more info). + // engine](https://packer.io/docs/templates/engine) for more info). AMIName string `mapstructure:"ami_name" required:"true"` // The description to set for the resulting // AMI(s). By default this description is empty. This is a - // [template engine](/docs/templates/engine.html), see [Build template + // [template engine](https://packer.io/docs/templates/engine), see [Build template // data](#build-template-data) for more information. AMIDescription string `mapstructure:"ami_description" required:"false"` // The type of virtualization for the AMI @@ -48,12 +48,12 @@ type AMIConfig struct { // validation of the ami_regions configuration option. Default false. AMISkipRegionValidation bool `mapstructure:"skip_region_validation" required:"false"` // Tags applied to the AMI. This is a - // [template engine](/docs/templates/engine.html), see [Build template + // [template engine](https://packer.io/docs/templates/engine), see [Build template // data](#build-template-data) for more information. AMITags map[string]string `mapstructure:"tags" required:"false"` // Same as [`tags`](#tags) but defined as a singular repeatable block // containing a `name` and a `value` field. In HCL2 mode the - // [`dynamic_block`](https://packer.io/docs/configuration/from-1.5/expressions.html#dynamic-blocks) + // [`dynamic_block`](https://packer.io/docs/configuration/from-1.5/expressions#dynamic-blocks) // will allow you to create those programatically. AMITag hcl2template.NameValues `mapstructure:"tag" required:"false"` // Enable enhanced networking (ENA but not SriovNetSupport) on @@ -119,12 +119,12 @@ type AMIConfig struct { AMISkipBuildRegion bool `mapstructure:"skip_save_build_region"` // Tags to apply to snapshot. // They will override AMI tags if already applied to snapshot. This is a - // [template engine](../templates/engine.html), see [Build template + // [template engine](https://packer.io/docs/templates/engine), see [Build template // data](#build-template-data) for more information. SnapshotTags map[string]string `mapstructure:"snapshot_tags" required:"false"` // Same as [`snapshot_tags`](#snapshot_tags) but defined as a singular // repeatable block containing a `name` and a `value` field. In HCL2 mode the - // [`dynamic_block`](https://packer.io/docs/configuration/from-1.5/expressions.html#dynamic-blocks) + // [`dynamic_block`](https://packer.io/docs/configuration/from-1.5/expressions#dynamic-blocks) // will allow you to create those programatically. SnapshotTag hcl2template.NameValues `mapstructure:"snapshot_tag" required:"false"` // A list of account IDs that have @@ -210,7 +210,7 @@ func (c *AMIConfig) Prepare(accessConfig *AccessConfig, ctx *interpolate.Context if len(c.SnapshotUsers) > 0 { if len(c.AMIKmsKeyId) == 0 && len(c.AMIRegionKMSKeyIDs) == 0 && c.AMIEncryptBootVolume.True() { errs = append(errs, fmt.Errorf("Cannot share snapshot encrypted "+ - "with default KMS key, see https://www.packer.io/docs/builders/amazon-ebs.html#region_kms_key_ids for more information")) + "with default KMS key, see https://www.packer.io/docs/builders/amazon-ebs#region_kms_key_ids for more information")) } if len(c.AMIRegionKMSKeyIDs) > 0 { for _, kmsKey := range c.AMIRegionKMSKeyIDs { diff --git a/builder/amazon/common/run_config.go b/builder/amazon/common/run_config.go index 5d33a006b..ff2880f2f 100644 --- a/builder/amazon/common/run_config.go +++ b/builder/amazon/common/run_config.go @@ -90,7 +90,7 @@ type RunConfig struct { // *will not* stop the instance but will assume that you will send the stop // signal yourself through your final provisioner. You can do this with a // [windows-shell - // provisioner](https://www.packer.io/docs/provisioners/windows-shell.html). + // provisioner](https://www.packer.io/docs/provisioners/windows-shell). // Note that Packer will still wait for the instance to be stopped, and // failing to send the stop signal yourself, when you have set this flag to // `true`, will cause a timeout. @@ -184,12 +184,12 @@ type RunConfig struct { // `security_group_ids` take precedence over this. SecurityGroupFilter SecurityGroupFilterOptions `mapstructure:"security_group_filter" required:"false"` // Tags to apply to the instance that is that is *launched* to create the - // EBS volumes. This is a [template engine](/docs/templates/engine.html), + // EBS volumes. This is a [template engine](https://packer.io/docs/templates/engine), // see [Build template data](#build-template-data) for more information. RunTags map[string]string `mapstructure:"run_tags" required:"false"` // Same as [`run_tags`](#run_tags) but defined as a singular repeatable // block containing a `name` and a `value` field. In HCL2 mode the - // [`dynamic_block`](https://packer.io/docs/configuration/from-1.5/expressions.html#dynamic-blocks) + // [`dynamic_block`](https://packer.io/docs/configuration/from-1.5/expressions#dynamic-blocks) // will allow you to create those programatically. RunTag hcl2template.NameValues `mapstructure:"run_tag" required:"false"` // The ID (not the name) of the security @@ -286,7 +286,7 @@ type RunConfig struct { SpotTags map[string]string `mapstructure:"spot_tags" required:"false"` // Same as [`spot_tags`](#spot_tags) but defined as a singular repeatable block // containing a `name` and a `value` field. In HCL2 mode the - // [`dynamic_block`](https://packer.io/docs/configuration/from-1.5/expressions.html#dynamic-blocks) + // [`dynamic_block`](https://packer.io/docs/configuration/from-1.5/expressions#dynamic-blocks) // will allow you to create those programatically. SpotTag hcl2template.NameValues `mapstructure:"spot_tag" required:"false"` // Filters used to populate the `subnet_id` field. diff --git a/builder/amazon/ebs/builder.go b/builder/amazon/ebs/builder.go index 7ae72b906..e05d2177c 100644 --- a/builder/amazon/ebs/builder.go +++ b/builder/amazon/ebs/builder.go @@ -52,7 +52,7 @@ type Config struct { // Tags to apply to the volumes that are *launched* to create the AMI. // These tags are *not* applied to the resulting AMI unless they're // duplicated in `tags`. This is a [template - // engine](/docs/templates/engine.html), see [Build template + // engine](https://packer.io/docs/templates/engine), see [Build template // data](#build-template-data) for more information. VolumeRunTags awscommon.TagMap `mapstructure:"run_volume_tags"` // Relevant only to Windows guests: If you set this flag, we'll add clauses diff --git a/builder/amazon/ebssurrogate/builder.go b/builder/amazon/ebssurrogate/builder.go index e0373a172..e8872f4d0 100644 --- a/builder/amazon/ebssurrogate/builder.go +++ b/builder/amazon/ebssurrogate/builder.go @@ -58,7 +58,7 @@ type Config struct { // Tags to apply to the volumes that are *launched* to create the AMI. // These tags are *not* applied to the resulting AMI unless they're // duplicated in `tags`. This is a [template - // engine](/docs/templates/engine.html), see [Build template + // engine](https://packer.io/docs/templates/engine), see [Build template // data](#build-template-data) for more information. VolumeRunTags awscommon.TagMap `mapstructure:"run_volume_tags"` // what architecture to use when registering the diff --git a/builder/amazon/ebsvolume/block_device.go b/builder/amazon/ebsvolume/block_device.go index 0b0c7f74e..5f6421462 100644 --- a/builder/amazon/ebsvolume/block_device.go +++ b/builder/amazon/ebsvolume/block_device.go @@ -12,12 +12,12 @@ import ( type BlockDevice struct { awscommon.BlockDevice `mapstructure:",squash"` // Tags to apply to the volume. These are retained after the builder - // completes. This is a [template engine](/docs/templates/engine.html), see + // completes. This is a [template engine](https://packer.io/docs/templates/engine), see // [Build template data](#build-template-data) for more information. Tags map[string]string `mapstructure:"tags" required:"false"` // Same as [`tags`](#tags) but defined as a singular repeatable block // containing a `name` and a `value` field. In HCL2 mode the - // [`dynamic_block`](https://packer.io/docs/configuration/from-1.5/expressions.html#dynamic-blocks) + // [`dynamic_block`](https://packer.io/docs/configuration/from-1.5/expressions#dynamic-blocks) // will allow you to create those programatically. Tag hcl2template.NameValues `mapstructure:"tag" required:"false"` } diff --git a/builder/amazon/ebsvolume/builder.go b/builder/amazon/ebsvolume/builder.go index f9af503ab..a89ee6ade 100644 --- a/builder/amazon/ebsvolume/builder.go +++ b/builder/amazon/ebsvolume/builder.go @@ -57,7 +57,7 @@ type Config struct { // create EBS Volumes. These tags will *not* appear in the tags of the // resulting EBS volumes unless they're duplicated under `tags` in the // `ebs_volumes` setting. This is a [template - // engine](/docs/templates/engine.html), see [Build template + // engine](https://packer.io/docs/templates/engine), see [Build template // data](#build-template-data) for more information. // // Note: The tags specified here will be *temporarily* applied to volumes @@ -69,7 +69,7 @@ type Config struct { // Same as [`run_volume_tags`](#run_volume_tags) but defined as a singular // repeatable block containing a `name` and a `value` field. In HCL2 mode // the - // [`dynamic_block`](https://packer.io/docs/configuration/from-1.5/expressions.html#dynamic-blocks) + // [`dynamic_block`](https://packer.io/docs/configuration/from-1.5/expressions#dynamic-blocks) // will allow you to create those programatically. VolumeRunTag hcl2template.NameValues `mapstructure:"run_volume_tag"` diff --git a/builder/azure/arm/config.go b/builder/azure/arm/config.go index ce3141897..c040fdabe 100644 --- a/builder/azure/arm/config.go +++ b/builder/azure/arm/config.go @@ -245,7 +245,7 @@ type Config struct { AzureTags map[string]*string `mapstructure:"azure_tags" required:"false"` // Same as [`azure_tags`](#azure_tags) but defined as a singular repeatable block // containing a `name` and a `value` field. In HCL2 mode the - // [`dynamic_block`](https://packer.io/docs/configuration/from-1.5/expressions.html#dynamic-blocks) + // [`dynamic_block`](https://packer.io/docs/configuration/from-1.5/expressions#dynamic-blocks) // will allow you to create those programatically. AzureTag hcl2template.NameValues `mapstructure:"azure_tag" required:"false"` // Resource group under which the final artifact will be stored. diff --git a/builder/docker/config.go b/builder/docker/config.go index 7ba00472c..9a03d2b7f 100644 --- a/builder/docker/config.go +++ b/builder/docker/config.go @@ -36,12 +36,12 @@ type Config struct { Commit bool `mapstructure:"commit" required:"true"` // The directory inside container to mount temp directory from host server - // for work [file provisioner](/docs/provisioners/file.html). This defaults + // for work [file provisioner](https://packer.io/docs/provisioners/file). This defaults // to c:/packer-files on windows and /packer-files on other systems. ContainerDir string `mapstructure:"container_dir" required:"false"` // Throw away the container when the build is complete. This is useful for // the [artifice - // post-processor](https://www.packer.io/docs/post-processors/artifice.html). + // post-processor](https://www.packer.io/docs/post-processors/artifice). Discard bool `mapstructure:"discard" required:"true"` // Username (UID) to run remote commands with. You can also set the group // name/ID if you want: (UID or UID:GID). You may need this if you get diff --git a/builder/googlecompute/config.go b/builder/googlecompute/config.go index aa0f6e13b..d47e7ece8 100644 --- a/builder/googlecompute/config.go +++ b/builder/googlecompute/config.go @@ -172,7 +172,7 @@ type Config struct { // Google's cloud. The value should be the path of the token generator // within vault. // For information on how to configure your Vault + GCP engine to produce - // Oauth tokens, see https://www.vaultproject.io/docs/auth/gcp.html + // Oauth tokens, see https://www.vaultproject.io/docs/auth/gcp // You must have the environment variables VAULT_ADDR and VAULT_TOKEN set, // along with any other relevant variables for accessing your vault // instance. For more information, see the Vault docs: diff --git a/builder/hyperone/config.go b/builder/hyperone/config.go index 8a1b51b09..a153a8afb 100644 --- a/builder/hyperone/config.go +++ b/builder/hyperone/config.go @@ -65,7 +65,7 @@ type Config struct { ImageTags map[string]string `mapstructure:"image_tags" required:"false"` // Same as [`image_tags`](#image_tags) but defined as a singular repeatable // block containing a `name` and a `value` field. In HCL2 mode the - // [`dynamic_block`](https://packer.io/docs/configuration/from-1.5/expressions.html#dynamic-blocks) + // [`dynamic_block`](https://packer.io/docs/configuration/from-1.5/expressions#dynamic-blocks) // will allow you to create those programatically. ImageTag hcl2template.NameValues `mapstructure:"image_tag" required:"false"` // The service of the resulting image. @@ -79,7 +79,7 @@ type Config struct { VmTags map[string]string `mapstructure:"vm_tags" required:"false"` // Same as [`vm_tags`](#vm_tags) but defined as a singular repeatable block // containing a `name` and a `value` field. In HCL2 mode the - // [`dynamic_block`](https://packer.io/docs/configuration/from-1.5/expressions.html#dynamic-blocks) + // [`dynamic_block`](https://packer.io/docs/configuration/from-1.5/expressions#dynamic-blocks) // will allow you to create those programatically. VmTag hcl2template.NameValues `mapstructure:"vm_tag" required:"false"` // The name of the created disk. diff --git a/builder/tencentcloud/cvm/run_config.go b/builder/tencentcloud/cvm/run_config.go index cf6739c6a..4501f14a3 100644 --- a/builder/tencentcloud/cvm/run_config.go +++ b/builder/tencentcloud/cvm/run_config.go @@ -86,7 +86,7 @@ type TencentCloudRunConfig struct { RunTags map[string]string `mapstructure:"run_tags" required:"false"` // Same as [`run_tags`](#run_tags) but defined as a singular repeatable // block containing a `name` and a `value` field. In HCL2 mode the - // [`dynamic_block`](https://packer.io/docs/configuration/from-1.5/expressions.html#dynamic-blocks) + // [`dynamic_block`](https://packer.io/docs/configuration/from-1.5/expressions#dynamic-blocks) // will allow you to create those programatically. RunTag hcl2template.NameValues `mapstructure:"run_tag" required:"false"` diff --git a/builder/triton/source_machine_config.go b/builder/triton/source_machine_config.go index da8e9419d..4c3ac2837 100644 --- a/builder/triton/source_machine_config.go +++ b/builder/triton/source_machine_config.go @@ -57,7 +57,7 @@ type SourceMachineConfig struct { MachineTags map[string]string `mapstructure:"source_machine_tags" required:"false"` // Same as [`source_machine_tags`](#source_machine_tags) but defined as a // singular block containing a `name` and a `value` field. In HCL2 mode the - // [`dynamic_block`](https://packer.io/docs/configuration/from-1.5/expressions.html#dynamic-blocks) + // [`dynamic_block`](https://packer.io/docs/configuration/from-1.5/expressions#dynamic-blocks) // will allow you to create those programatically. MachineTag hcl2template.NameValues `mapstructure:"source_machine_tag" required:"false"` // Whether or not the firewall diff --git a/builder/triton/target_image_config.go b/builder/triton/target_image_config.go index 67ad946f2..8ec7f16ce 100644 --- a/builder/triton/target_image_config.go +++ b/builder/triton/target_image_config.go @@ -39,7 +39,7 @@ type TargetImageConfig struct { ImageTags map[string]string `mapstructure:"image_tags" required:"false"` // Same as [`image_tags`](#image_tags) but defined as a singular repeatable // block containing a `name` and a `value` field. In HCL2 mode the - // [`dynamic_block`](https://packer.io/docs/configuration/from-1.5/expressions.html#dynamic-blocks) + // [`dynamic_block`](https://packer.io/docs/configuration/from-1.5/expressions#dynamic-blocks) // will allow you to create those programatically. ImageTag hcl2template.NameValues `mapstructure:"image_tag" required:"false"` } diff --git a/builder/virtualbox/common/vboxmanage_config.go b/builder/virtualbox/common/vboxmanage_config.go index 75c845a29..8eaeead35 100644 --- a/builder/virtualbox/common/vboxmanage_config.go +++ b/builder/virtualbox/common/vboxmanage_config.go @@ -14,7 +14,7 @@ type VBoxManageConfig struct { // array of strings, where each string represents a single argument on the // command-line to `VBoxManage` (but excluding `VBoxManage` itself). Each // arg is treated as a [configuration - // template](/docs/templates/engine.html), where the `Name` variable is + // template](https://packer.io/docs/templates/engine), where the `Name` variable is // replaced with the VM name. More details on how to use `VBoxManage` are // below. VBoxManage [][]string `mapstructure:"vboxmanage" required:"false"` diff --git a/builder/vmware/common/export_config.go b/builder/vmware/common/export_config.go index 1ae85d759..31b6bd88f 100644 --- a/builder/vmware/common/export_config.go +++ b/builder/vmware/common/export_config.go @@ -22,7 +22,7 @@ type ExportConfig struct { // argument. Currently, exporting the build VM (with ovftool) is only // supported when building on ESXi e.g. when `remote_type` is set to // `esx5`. See the [Building on a Remote vSphere - // Hypervisor](/docs/builders/vmware-iso.html#building-on-a-remote-vsphere-hypervisor) + // Hypervisor](https://packer.io/docs/builders/vmware-iso#building-on-a-remote-vsphere-hypervisor) // section below for more info. OVFToolOptions []string `mapstructure:"ovftool_options" required:"false"` // Defaults to `false`. When enabled, Packer will not export the VM. Useful @@ -30,7 +30,7 @@ type ExportConfig struct { // VM. Currently, exporting the build VM is only supported when building on // ESXi e.g. when `remote_type` is set to `esx5`. See the [Building on a // Remote vSphere - // Hypervisor](/docs/builders/vmware-iso.html#building-on-a-remote-vsphere-hypervisor) + // Hypervisor](https://packer.io/docs/builders/vmware-iso#building-on-a-remote-vsphere-hypervisor) // section below for more info. SkipExport bool `mapstructure:"skip_export" required:"false"` // Set this to true if you would like to keep diff --git a/builder/vmware/common/tools_config.go b/builder/vmware/common/tools_config.go index 4830ff30c..86090d08e 100644 --- a/builder/vmware/common/tools_config.go +++ b/builder/vmware/common/tools_config.go @@ -13,7 +13,7 @@ type ToolsConfig struct { ToolsUploadFlavor string `mapstructure:"tools_upload_flavor" required:"false"` // The path in the VM to upload the VMware tools. This only takes effect if // `tools_upload_flavor` is non-empty. This is a [configuration - // template](/docs/templates/engine.html) that has a single valid variable: + // template](https://packer.io/docs/templates/engine) that has a single valid variable: // `Flavor`, which will be the value of `tools_upload_flavor`. By default // the upload path is set to `{{.Flavor}}.iso`. This setting is not used // when `remote_type` is `esx5`. diff --git a/builder/vmware/iso/config.go b/builder/vmware/iso/config.go index 596ce26ea..12325bad7 100644 --- a/builder/vmware/iso/config.go +++ b/builder/vmware/iso/config.go @@ -107,7 +107,7 @@ type Config struct { VMName string `mapstructure:"vm_name" required:"false"` VMXDiskTemplatePath string `mapstructure:"vmx_disk_template_path"` - // Path to a [configuration template](/docs/templates/engine.html) that + // Path to a [configuration template](https://packer.io/docs/templates/engine) that // defines the contents of the virtual machine VMX file for VMware. The // engine has access to the template variables `{{ .DiskNumber }}` and // `{{ .DiskName }}`. diff --git a/common/bootcommand/config.go b/common/bootcommand/config.go index 5c5d2676c..816fdc7bf 100644 --- a/common/bootcommand/config.go +++ b/common/bootcommand/config.go @@ -105,7 +105,7 @@ import ( // ] // ``` // For more examples of various boot commands, see the sample projects from our -// [community templates page](/community-tools.html#templates). +// [community templates page](https://packer.io/community-tools#templates). type BootConfig struct { // Time to wait after sending a group of key pressses. The value of this // should be a duration. Examples are `5s` and `1m30s` which will cause diff --git a/common/floppy_config.go b/common/floppy_config.go index c2c617ed8..7abcb160d 100644 --- a/common/floppy_config.go +++ b/common/floppy_config.go @@ -18,7 +18,7 @@ import ( // is attached as the first floppy device. The summary size of the listed files // must not exceed 1.44 MB. The supported ways to move large files into the OS // are using `http_directory` or [the file -// provisioner](https://www.packer.io/docs/provisioners/file.html). +// provisioner](https://packer.io/docs/provisioners/file). type FloppyConfig struct { // A list of files to place onto a floppy disk that is attached when the VM // is booted. Currently, no support exists for creating sub-directories on diff --git a/helper/communicator/config.go b/helper/communicator/config.go index c8b832365..9aaa14095 100644 --- a/helper/communicator/config.go +++ b/helper/communicator/config.go @@ -175,7 +175,7 @@ type WinRM struct { // // NOTE: If using an Amazon EBS builder, you can specify the interface // WinRM connects to via - // [`ssh_interface`](https://www.packer.io/docs/builders/amazon-ebs.html#ssh_interface) + // [`ssh_interface`](https://www.packer.io/docs/builders/amazon-ebs#ssh_interface) WinRMHost string `mapstructure:"winrm_host"` // The WinRM port to connect to. This defaults to `5985` for plain // unencrypted connection and `5986` for SSL when `winrm_use_ssl` is set to diff --git a/website/pages/docs/builders/outscale/bsu.mdx b/website/pages/docs/builders/outscale/bsu.mdx index 5fc34aa48..6f20ed80f 100644 --- a/website/pages/docs/builders/outscale/bsu.mdx +++ b/website/pages/docs/builders/outscale/bsu.mdx @@ -103,7 +103,7 @@ builder. sometimes desirable to [run Sysprep]() which will stop the VM for you. If this is set to `true`, Packer _will not_ stop the VM but will assume that you will send the stop signal yourself through your final provisioner. You can do this with a - [windows-shell provisioner](https://www.packer.io/docs/provisioners/windows-shell). + [windows-shell provisioner](/docs/provisioners/windows-shell). Note that Packer will still wait for the VM to be stopped, and failing to send the stop signal yourself, when you have set this flag to diff --git a/website/pages/docs/builders/outscale/bsusurrogate.mdx b/website/pages/docs/builders/outscale/bsusurrogate.mdx index e9570b797..f5075d51e 100644 --- a/website/pages/docs/builders/outscale/bsusurrogate.mdx +++ b/website/pages/docs/builders/outscale/bsusurrogate.mdx @@ -99,7 +99,7 @@ builder. sometimes desirable to [run Sysprep]() which will stop the VM for you. If this is set to `true`, Packer _will not_ stop the VM but will assume that you will send the stop signal yourself through your final provisioner. You can do this with a - [windows-shell provisioner](https://www.packer.io/docs/provisioners/windows-shell). + [windows-shell provisioner](/docs/provisioners/windows-shell). Note that Packer will still wait for the VM to be stopped, and failing to send the stop signal yourself, when you have set this flag to diff --git a/website/pages/docs/builders/outscale/bsuvolume.mdx b/website/pages/docs/builders/outscale/bsuvolume.mdx index 3bea57819..cc45c7a04 100644 --- a/website/pages/docs/builders/outscale/bsuvolume.mdx +++ b/website/pages/docs/builders/outscale/bsuvolume.mdx @@ -92,7 +92,7 @@ builder. sometimes desirable to [run Sysprep]() which will stop the VM for you. If this is set to `true`, Packer _will not_ stop the VM but will assume that you will send the stop signal yourself through your final provisioner. You can do this with a - [windows-shell provisioner](https://www.packer.io/docs/provisioners/windows-shell). + [windows-shell provisioner](/docs/provisioners/windows-shell). Note that Packer will still wait for the VM to be stopped, and failing to send the stop signal yourself, when you have set this flag to diff --git a/website/pages/docs/extending/custom-builders.mdx b/website/pages/docs/extending/custom-builders.mdx index d654fc978..98836d2d6 100644 --- a/website/pages/docs/extending/custom-builders.mdx +++ b/website/pages/docs/extending/custom-builders.mdx @@ -43,7 +43,7 @@ type Builder interface { This method returns a hcldec.ObjectSpec, which is a spec necessary for using HCL2 templates with Packer. For information on how to use and implement this function, check our -[object spec docs](https://www.packer.io/guides/hcl/component-object-spec) +[object spec docs](/guides/hcl/component-object-spec) ### The "Prepare" Method diff --git a/website/pages/docs/extending/custom-post-processors.mdx b/website/pages/docs/extending/custom-post-processors.mdx index 8627dcf99..ac8a719de 100644 --- a/website/pages/docs/extending/custom-post-processors.mdx +++ b/website/pages/docs/extending/custom-post-processors.mdx @@ -50,7 +50,7 @@ type PostProcessor interface { This method returns a hcldec.ObjectSpec, which is a spec necessary for using HCL2 templates with Packer. For information on how to use and implement this function, check our -[object spec docs](https://www.packer.io/guides/hcl/component-object-spec) +[object spec docs](/guides/hcl/component-object-spec) ### The "Configure" Method diff --git a/website/pages/docs/extending/custom-provisioners.mdx b/website/pages/docs/extending/custom-provisioners.mdx index 0b491ada4..38f5dac14 100644 --- a/website/pages/docs/extending/custom-provisioners.mdx +++ b/website/pages/docs/extending/custom-provisioners.mdx @@ -77,7 +77,7 @@ may be displayed to the user before anything actually happens. This method returns a hcldec.ObjectSpec, which is a spec necessary for using HCL2 templates with Packer. For information on how to use and implement this function, check our -[object spec docs](https://www.packer.io/guides/hcl/component-object-spec) +[object spec docs](/guides/hcl/component-object-spec) ### The "Provision" Method diff --git a/website/pages/docs/post-processors/artifice.mdx b/website/pages/docs/post-processors/artifice.mdx index 9d7431199..f2d79a302 100644 --- a/website/pages/docs/post-processors/artifice.mdx +++ b/website/pages/docs/post-processors/artifice.mdx @@ -31,8 +31,8 @@ instance. After overriding the artifact with artifice, you can use it with other post-processors like -[compress](https://www.packer.io/docs/post-processors/compress), -[docker-push](https://www.packer.io/docs/post-processors/docker-push), or +[compress](/docs/post-processors/compress), +[docker-push](/docs/post-processors/docker-push), or a third-party post-processor. Artifice allows you to use the familiar packer workflow to create a fresh, diff --git a/website/pages/partials/builder/amazon/common/RunConfig-not-required.mdx b/website/pages/partials/builder/amazon/common/RunConfig-not-required.mdx index 61dd1506f..51383f2ab 100644 --- a/website/pages/partials/builder/amazon/common/RunConfig-not-required.mdx +++ b/website/pages/partials/builder/amazon/common/RunConfig-not-required.mdx @@ -207,7 +207,7 @@ - `spot_tag` ([]{name string, value string}) - Same as [`spot_tags`](#spot_tags) but defined as a singular repeatable block containing a `name` and a `value` field. In HCL2 mode the - [`dynamic_block`](https://packer.io/docs/configuration/from-1.5/expressions#dynamic-blocks) + [`dynamic_block`](/docs/configuration/from-1.5/expressions#dynamic-blocks) will allow you to create those programatically. - `subnet_filter` (SubnetFilterOptions) - Filters used to populate the `subnet_id` field. diff --git a/website/pages/partials/builder/hyperone/Config-not-required.mdx b/website/pages/partials/builder/hyperone/Config-not-required.mdx index 46a04feb1..fdf15e95c 100644 --- a/website/pages/partials/builder/hyperone/Config-not-required.mdx +++ b/website/pages/partials/builder/hyperone/Config-not-required.mdx @@ -19,7 +19,7 @@ - `image_tag` ([]{name string, value string}) - Same as [`image_tags`](#image_tags) but defined as a singular repeatable block containing a `name` and a `value` field. In HCL2 mode the - [`dynamic_block`](https://packer.io/docs/configuration/from-1.5/expressions#dynamic-blocks) + [`dynamic_block`](/docs/configuration/from-1.5/expressions#dynamic-blocks) will allow you to create those programatically. - `image_service` (string) - The service of the resulting image. @@ -31,7 +31,7 @@ - `vm_tag` ([]{name string, value string}) - Same as [`vm_tags`](#vm_tags) but defined as a singular repeatable block containing a `name` and a `value` field. In HCL2 mode the - [`dynamic_block`](https://packer.io/docs/configuration/from-1.5/expressions#dynamic-blocks) + [`dynamic_block`](/docs/configuration/from-1.5/expressions#dynamic-blocks) will allow you to create those programatically. - `disk_name` (string) - The name of the created disk. diff --git a/website/pages/partials/builder/tencentcloud/cvm/TencentCloudRunConfig-not-required.mdx b/website/pages/partials/builder/tencentcloud/cvm/TencentCloudRunConfig-not-required.mdx index 98ff731da..06ca4ff1a 100644 --- a/website/pages/partials/builder/tencentcloud/cvm/TencentCloudRunConfig-not-required.mdx +++ b/website/pages/partials/builder/tencentcloud/cvm/TencentCloudRunConfig-not-required.mdx @@ -58,7 +58,7 @@ - `run_tag` ([]{name string, value string}) - Same as [`run_tags`](#run_tags) but defined as a singular repeatable block containing a `name` and a `value` field. In HCL2 mode the - [`dynamic_block`](https://packer.io/docs/configuration/from-1.5/expressions#dynamic-blocks) + [`dynamic_block`](/docs/configuration/from-1.5/expressions#dynamic-blocks) will allow you to create those programatically. - `ssh_private_ip` (bool) - SSH Private Ip diff --git a/website/pages/partials/builder/triton/SourceMachineConfig-not-required.mdx b/website/pages/partials/builder/triton/SourceMachineConfig-not-required.mdx index 52770650d..fc57c1cb1 100644 --- a/website/pages/partials/builder/triton/SourceMachineConfig-not-required.mdx +++ b/website/pages/partials/builder/triton/SourceMachineConfig-not-required.mdx @@ -27,7 +27,7 @@ - `source_machine_tag` ([]{name string, value string}) - Same as [`source_machine_tags`](#source_machine_tags) but defined as a singular block containing a `name` and a `value` field. In HCL2 mode the - [`dynamic_block`](https://packer.io/docs/configuration/from-1.5/expressions#dynamic-blocks) + [`dynamic_block`](/docs/configuration/from-1.5/expressions#dynamic-blocks) will allow you to create those programatically. - `source_machine_firewall_enabled` (bool) - Whether or not the firewall diff --git a/website/pages/partials/builder/triton/TargetImageConfig-not-required.mdx b/website/pages/partials/builder/triton/TargetImageConfig-not-required.mdx index 1d8dee4d9..fb4cf3801 100644 --- a/website/pages/partials/builder/triton/TargetImageConfig-not-required.mdx +++ b/website/pages/partials/builder/triton/TargetImageConfig-not-required.mdx @@ -17,5 +17,5 @@ - `image_tag` ([]{name string, value string}) - Same as [`image_tags`](#image_tags) but defined as a singular repeatable block containing a `name` and a `value` field. In HCL2 mode the - [`dynamic_block`](https://packer.io/docs/configuration/from-1.5/expressions#dynamic-blocks) + [`dynamic_block`](/docs/configuration/from-1.5/expressions#dynamic-blocks) will allow you to create those programatically. diff --git a/website/pages/partials/common/FloppyConfig.mdx b/website/pages/partials/common/FloppyConfig.mdx index 165bedbcc..bca819832 100644 --- a/website/pages/partials/common/FloppyConfig.mdx +++ b/website/pages/partials/common/FloppyConfig.mdx @@ -7,4 +7,4 @@ this setting get placed into the root directory of the floppy and the floppy is attached as the first floppy device. The summary size of the listed files must not exceed 1.44 MB. The supported ways to move large files into the OS are using `http_directory` or [the file -provisioner](https://www.packer.io/docs/provisioners/file). +provisioner](/docs/provisioners/file). diff --git a/website/pages/partials/helper/communicator/WinRM-not-required.mdx b/website/pages/partials/helper/communicator/WinRM-not-required.mdx index 778820f0f..94029cb68 100644 --- a/website/pages/partials/helper/communicator/WinRM-not-required.mdx +++ b/website/pages/partials/helper/communicator/WinRM-not-required.mdx @@ -8,7 +8,7 @@ NOTE: If using an Amazon EBS builder, you can specify the interface WinRM connects to via - [`ssh_interface`](https://www.packer.io/docs/builders/amazon-ebs#ssh_interface) + [`ssh_interface`](/docs/builders/amazon-ebs#ssh_interface) - `winrm_port` (int) - The WinRM port to connect to. This defaults to `5985` for plain unencrypted connection and `5986` for SSL when `winrm_use_ssl` is set to