aherman
/
packer
mirror of https://github.com/hashicorp/packer
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix broken links detected by link checker

Browse Source 
- Fix broken example links
- Fix broken provisioner links
- Ignore linode.com because of DDOS protection settings
pull/10442/head
Wilken Rivera 6 years ago
parent 7b793cefb1
commit 04dbbe2d8e
30 changed files with 63 additions and 47 deletions
Show Stats Download Patch File Download Diff File

2
builder/amazon/common/run_config.go
Unescape View File

@ -85,7 +85,7 @@ type RunConfig struct {
BlockDurationMinutes int64 `mapstructure:"block_duration_minutes" required:"false"`
// Packer normally stops the build instance after all provisioners have
// run. For Windows instances, it is sometimes desirable to [run
// Sysprep](http://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ami-create-standard.html)
// Sysprep](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/Creating_EBSbacked_WinAMI.html)
// which will stop the instance for you. If this is set to `true`, Packer
// *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

6
builder/azure/arm/config.go
Unescape View File

@ -196,20 +196,20 @@ type Config struct {
// Image Definition won't use this Image Version.
SharedGalleryImageVersionExcludeFromLatest bool `mapstructure:"shared_gallery_image_version_exclude_from_latest" required:"false"`
// Name of the publisher to use for your base image (Azure Marketplace Images only). See
// [documentation](https://azure.microsoft.com/en-us/documentation/articles/resource-groups-vm-searching/)
// [documentation](https://docs.microsoft.com/en-us/cli/azure/vm/image)
// for details.
//
// CLI example `az vm image list-publishers --location westus`
ImagePublisher string `mapstructure:"image_publisher" required:"true"`
// Name of the publisher's offer to use for your base image (Azure Marketplace Images only). See
// [documentation](https://azure.microsoft.com/en-us/documentation/articles/resource-groups-vm-searching/)
// [documentation](https://docs.microsoft.com/en-us/cli/azure/vm/image)
// for details.
//
// CLI example
// `az vm image list-offers --location westus --publisher Canonical`
ImageOffer string `mapstructure:"image_offer" required:"true"`
// SKU of the image offer to use for your base image (Azure Marketplace Images only). See
// [documentation](https://azure.microsoft.com/en-us/documentation/articles/resource-groups-vm-searching/)
// [documentation](https://docs.microsoft.com/en-us/cli/azure/vm/image)
// for details.
//
// CLI example

6
builder/azure/dtl/config.go
Unescape View File

@ -143,20 +143,20 @@ type Config struct {
SharedGalleryTimeout time.Duration `mapstructure:"shared_image_gallery_timeout"`
// PublisherName for your base image. See
// [documentation](https://azure.microsoft.com/en-us/documentation/articles/resource-groups-vm-searching/)
// [documentation](https://docs.microsoft.com/en-us/cli/azure/vm/image)
// for details.
//
// CLI example `az vm image list-publishers --location westus`
ImagePublisher string `mapstructure:"image_publisher"`
// Offer for your base image. See
// [documentation](https://azure.microsoft.com/en-us/documentation/articles/resource-groups-vm-searching/)
// [documentation](https://docs.microsoft.com/en-us/cli/azure/vm/image)
// for details.
//
// CLI example
// `az vm image list-offers --location westus --publisher Canonical`
ImageOffer string `mapstructure:"image_offer"`
// SKU for your base image. See
// [documentation](https://azure.microsoft.com/en-us/documentation/articles/resource-groups-vm-searching/)
// [documentation](https://docs.microsoft.com/en-us/cli/azure/vm/image)
// for details.
//
// CLI example

2
builder/vagrant/builder.go
Unescape View File

@ -71,7 +71,7 @@ type Config struct {
// * ebfb681885ddf1234c18094a45bbeafd91467911
// * sha256:ed363350696a726b7932db864dda019bd2017365c9e299627830f06954643f93
// * ed363350696a726b7932db864dda019bd2017365c9e299627830f06954643f93
// * file:http://releases.ubuntu.com/20.04/MD5SUMS
// * file:http://releases.ubuntu.com/20.04/SHA256SUMS
// * file:file://./local/path/file.sum
// * file:./local/path/file.sum
// * none

2
builder/virtualbox/ovf/config.go
Unescape View File

@ -43,7 +43,7 @@ type Config struct {
// * ebfb681885ddf1234c18094a45bbeafd91467911
// * sha256:ed363350696a726b7932db864dda019bd2017365c9e299627830f06954643f93
// * ed363350696a726b7932db864dda019bd2017365c9e299627830f06954643f93
// * file:http://releases.ubuntu.com/20.04/MD5SUMS
// * file:http://releases.ubuntu.com/20.04/SHA256SUMS
// * file:file://./local/path/file.sum
// * file:./local/path/file.sum
// * none

2
builder/vsphere/common/step_config_params.go
Unescape View File

@ -16,7 +16,7 @@ import (
type ConfigParamsConfig struct {
// configuration_parameters is a direct passthrough to the VSphere API's
// ConfigSpec: https://pubs.vmware.com/vi3/sdk/ReferenceGuide/vim.vm.ConfigSpec.html
// ConfigSpec: https://www.vmware.com/support/developer/vc-sdk/visdk41pubs/ApiReference/vim.vm.ConfigSpec.html
ConfigParams map[string]string `mapstructure:"configuration_parameters"`
// Enables time synchronization with the host. Defaults to false.

9
mlc_config.json
Unescape View File

@ -1,5 +1,14 @@
{
"ignorePatterns": [
{
"pattern": "^https://example.com"
},
{
"pattern": "^https://ec2.custom.endpoint.com"
},
{
"pattern": "^https://www.linode.com"
},
{
"pattern": "^https://github.com/hashicorp/packer-plugin-scaffolding"
}

6
website/content/docs/builders/alicloud-ecs.mdx
Unescape View File

@ -132,11 +132,11 @@ build {
~> Note: Since WinRM is closed by default in the system image. If you are
planning to use Windows as the base image, you need enable it by userdata in
order to connect to the instance, check
[alicloud_windows.json](https://github.com/hashicorp/packer/tree/master/examples/alicloud/basic/alicloud_windows.json)
[alicloud_windows.json](https://github.com/hashicorp/packer/tree/master/builder/alicloud/examples/basic/alicloud_windows.json)
and
[winrm_enable_userdata.ps1](https://github.com/hashicorp/packer/tree/master/examples/alicloud/basic/winrm_enable_userdata.ps1)
[winrm_enable_userdata.ps1](https://github.com/hashicorp/packer/tree/master/builder/alicloud/examples/basic/winrm_enable_userdata.ps1)
for details.
See the
[examples/alicloud](https://github.com/hashicorp/packer/tree/master/examples/alicloud)
[examples/alicloud](https://github.com/hashicorp/packer/tree/master/builder/alicloud/examples)
folder in the packer project for more examples.

4
website/content/docs/builders/azure/arm.mdx
Unescape View File

@ -234,7 +234,7 @@ means executing sysprep, and for Linux this means executing the waagent
deprovision process.
Please refer to the Azure
[examples](https://github.com/hashicorp/packer/tree/master/examples/azure) for
[examples](https://github.com/hashicorp/packer/tree/master/builder/azure/examples) for
complete examples showing the deprovision process.
### Windows
@ -489,5 +489,5 @@ templates and deployments. The time required to deploy a KeyVault template is
minimal, so overall impact is small.
See the
[examples/azure](https://github.com/hashicorp/packer/tree/master/examples/azure)
[examples/azure](https://github.com/hashicorp/packer/tree/master/builder/azure/examples)
folder in the packer project for more examples.

2
website/content/docs/builders/jdcloud.mdx
Unescape View File

@ -85,4 +85,4 @@ Here is a basic example for JDCloud.
}
```
[Find more examples](https://github.com/hashicorp/packer/tree/master/examples/jdcloud)
[Find more examples](https://github.com/hashicorp/packer/tree/master/builder/jdcloud/examples)

6
website/content/docs/builders/linode.mdx
Unescape View File

@ -41,6 +41,12 @@ can also be supplied to override the typical auto-generated key:
@include 'packer-plugin-sdk/communicator/SSH-Private-Key-File-not-required.mdx'
<!--
Linode.com has DDOS protection that returns 403 for the markdown link checker
so the domain has been added to the ignorepatterns in mlc_config.json
See https://github.com/tcort/markdown-link-check/issues/109
-->
### Required
- `linode_token` (string) - The client TOKEN to use to access your account.

2
website/content/docs/builders/oneandone.mdx
Unescape View File

@ -45,8 +45,10 @@ can also be supplied to override the typical auto-generated key:
- `retries` (number) - Number of retries Packer will make status requests
while waiting for the build to complete. Default value "600".
<!-- markdown-link-check-disable -->
- `url` (string) - Endpoint for the 1&1 REST API. Default URL
"<https://cloudpanel-api.1and1.com/v1>"
<!-- markdown-link-check-enable -->
## Example

10
website/content/docs/builders/oracle/classic.mdx
Unescape View File

@ -17,7 +17,7 @@ image, runs any provisioning necessary on the base image after launching it,
and finally snapshots it creating a reusable custom image.
It is recommended that you familiarise yourself with the [Key Concepts and
Terminology](https://docs.oracle.com/en/cloud/iaas/compute-iaas-cloud/stcsg/terminology.html)
Terminology](https://docs.oracle.com/en/cloud/iaas-classic/compute-iaas-cloud/stcsg/getting-started-oracle-compute-cloud-service.html#GUID-6CB9D494-4F3C-4B78-BD03-127983FEC357)
prior to using this builder if you have not done so already.
The builder _does not_ manage images. Once it creates an image, it is up to you
@ -52,7 +52,7 @@ builder. This builder currently only works with the SSH communicator.
- `source_image_list` (string) - This is what image you want to use as your
base image. See the
[documentation](https://docs.oracle.com/en/cloud/iaas/compute-iaas-cloud/stcsg/listing-machine-images.html)
[documentation](https://docs.oracle.com/en/cloud/iaas-classic/compute-iaas-cloud/stcsg/managing-machine-images.html#GUID-652E6797-A5B8-40A7-860F-F27FF3E42471)
for more details. You may use either a public image list, or a private
image list. To see what public image lists are available, you can use the
CLI, as described
@ -66,7 +66,7 @@ builder. This builder currently only works with the SSH communicator.
- `shape` (string) - The template that determines the number of CPUs, amount
of memory, and other resources allocated to a newly created instance. For
more information about shapes, see the documentation
[here](https://docs.oracle.com/en/cloud/iaas/compute-iaas-cloud/stcsg/machine-images-and-shapes.html).
[here](https://docs.oracle.com/en/cloud/iaas-classic/compute-iaas-cloud/stcsg/creating-instances.html#GUID-1DD0FA71-AC7B-461C-B8C1-14892725AA69).
- `username` (string) - Your account username.
@ -133,10 +133,6 @@ size of the original. We connect to this instance and copy the contents of the
first volume into a tarball file on the second volume. We then upload this file
to Object Storage Classic, and create a new machine image with it.
For more details, see this [blog
post](https://blogs.oracle.com/cloudmarketplace/creating-an-oracle-compute-machine-image-from-an-instance-with-persistent-boot-storage),
which discusses the strategy used here.
If this is set, a few more options become available.
- `builder_communicator` (communicator) - This represents an

2
website/content/docs/builders/oracle/oci.mdx
Unescape View File

@ -186,12 +186,14 @@ can also be supplied to override the typical auto-generated key:
- `use_private_ip` (boolean) - Use private ip addresses to connect to the
instance via ssh.
<!-- markdown-link-check-disable -->
- `metadata` (map of strings) - Metadata optionally contains custom metadata
key/value pairs provided in the configuration. While this can be used to
set metadata\["user_data"\] the explicit "user_data" and
"user_data_file" values will have precedence. An instance's metadata can
be obtained from at [http://169.254.169.254](http://169.254.169.254) on
the launched instance.
<!-- markdown-link-check-enable -->
- `user_data` (string) - User data to be used by cloud-init. See [the Oracle
docs](https://docs.us-phoenix-1.oraclecloud.com/api/#/en/iaas/20160918/LaunchInstanceDetails)

2
website/content/docs/builders/outscale/chroot.mdx
Unescape View File

@ -158,7 +158,7 @@ each category, the available configuration keys are alphabetized.
when mounting devices. Each option will be prefixed with `-o` and supplied
to the `mount` command ran by Packer. Because this command is ran in a
shell, user discretion is advised. See [this manual page for the mount
command](http://linuxcommand.org/man_pages/mount8.html) for valid file
command](https://linux.die.net/man/8/mount) for valid file
system specific options.
- `nvme_device_path` (string) - When we call the mount command (by default

4
website/content/docs/builders/outscale/index.mdx
Unescape View File

@ -105,13 +105,13 @@ export OUTSCALE_X509KEY="the/path/to/your/x509key"
### Checking that system time is current
Outscale uses the current time as part of the [request signing
process](http://docs.aws.osc.com/general/latest/gr/sigv4_signing.html). If
process](https://wiki.outscale.net/display/EN/About+Signatures+of+API+Requests). If
your system clock is too skewed from the current time, your requests might
fail. If that's the case, you might see an error like this:
==> osc-bsu: Error querying OMI: AuthFailure: OUTSCALE was not able to validate the provided access credentials
If you suspect your system's date is wrong, you can compare it against
<http://www.time.gov/>. On Linux/OS X, you can run the `date` command to get
<https://www.time.gov/>. On Linux/OS X, you can run the `date` command to get
the current time. If you're on Linux, you can try setting the time with ntp by
running `sudo ntpd -q`.

3
website/content/docs/builders/profitbricks.mdx
Unescape View File

@ -60,9 +60,10 @@ can also be supplied to override the typical auto-generated key:
generate it
- `snapshot_password` (string) - Password for the snapshot.
<!-- markdown-link-check-disable -->
- `url` (string) - Endpoint for the ProfitBricks REST API. Default URL
"<https://api.profitbricks.com/rest/v2>"
<!-- markdown-link-check-enable -->
## Example

2
website/content/docs/builders/tencentcloud-cvm.mdx
Unescape View File

@ -182,5 +182,5 @@ Here is a basic example for Tencentcloud.
```
See the
[examples/tencentcloud](https://github.com/hashicorp/packer/tree/master/examples/tencentcloud)
[examples/tencentcloud](https://github.com/hashicorp/packer/tree/master/builder/tencentcloud/examples)
folder in the packer project for more examples.

8
website/content/docs/extending/custom-builders.mdx
Unescape View File

@ -56,7 +56,7 @@ configuration, with later parameters overwriting any previous configuration.
The exact semantics of the merge are left to the builder author.
For decoding the `interface{}` into a meaningful structure, the
[mapstructure](https://github.com/mitchellh/mapstructure) library is
[mapstructure](https://godoc.org/github.com/mitchellh/mapstructure) library is
recommended. Mapstructure will take an `interface{}` and decode it into an
arbitrarily complex struct. If there are any errors, it generates very human
friendly errors that can be returned directly from the prepare method.
@ -88,8 +88,8 @@ And `packer.Cache` is used to store files between multiple Packer runs, and is
covered in more detail in the cache section below.
Because builder runs are typically a complex set of many steps, the
[multistep](https://github.com/hashicorp/packer/blob/master/helper/multistep)
helper is recommended to bring order to the complexity. Multistep is a library
[multistep](https://godoc.org/github.com/hashicorp/packer-plugin-sdk/multistep)
package is recommended to bring order to the complexity. Multistep is a library
which allows you to separate your logic into multiple distinct "steps" and
string them together. It fully supports cancellation mid-step and so on. Please
check it out, it is how the built-in builders are all implemented.
@ -137,7 +137,7 @@ about the artifact results, so it is important it never changes.
Other than the builder ID, the rest should be self-explanatory by reading the
[packer.Artifact interface
documentation](https://github.com/hashicorp/packer/blob/master/packer/artifact.go).
documentation](https://godoc.org/github.com/hashicorp/packer-plugin-sdk/packer#Artifact).
## Provisioning

2
website/content/docs/extending/custom-provisioners.mdx
Unescape View File

@ -101,7 +101,7 @@ some sort) or it may be remote (in a cloud). The communicator interface
abstracts this away so that communication is the same overall.
The documentation around the [code
itself](https://github.com/hashicorp/packer/blob/master/packer/communicator.go)
itself](https://godoc.org/github.com/hashicorp/packer-plugin-sdk/packer#Communicator)
is really great as an overview of how to use the interface. You should begin by
reading this. Once you have read it, you can see some example usage below:

2
website/content/docs/from-1.5/expressions.mdx
Unescape View File

@ -135,7 +135,7 @@ Packer makes one named values available.
The following named values are available:
- `source.<SOURCE TYPE>.<NAME>` is an object representing a
[source](/docs/from-1.5/sources) of the given type
[source](/docs/from-1.5/blocks/source) of the given type
and name.
### Available Functions

2
website/content/docs/provisioners/ansible.mdx
Unescape View File

@ -388,7 +388,7 @@ class Connection(SSHConnection):
Newer versions of Ansible require all plugins to have a documentation string.
You can see if there is a plugin available for the version of Ansible you are
using
[here](https://github.com/hashicorp/packer/tree/master/examples/ansible/connection-plugin).
[here](https://github.com/hashicorp/packer/tree/master/provisioner/ansible/examples/connection-plugin).
To create the plugin yourself, you will need to copy all of the `options` from
the `DOCUMENTATION` string from the [ssh.py Ansible connection

2
website/content/docs/provisioners/chef-client.mdx
Unescape View File

@ -109,7 +109,7 @@ configuration is actually required.
windows.
- `run_list` (array of strings) - The [run
list](http://docs.chef.io/essentials_node_object_run_lists) for Chef.
list](https://docs.chef.io/run_lists) for Chef.
By default this is empty, and will use the run list sent down by the Chef
Server.

2
website/content/docs/provisioners/puppet-server.mdx
Unescape View File

@ -84,7 +84,7 @@ listed below:
```
* `facter` (object of key/value strings) - Additional
[facts](https://puppetlabs.com/facter) to make available to the Puppet run.
[facts](https://puppet.com/docs/puppet/latest/facter.html) to make available to the Puppet run.
* `guest_os_type` (string) - The remote host's OS type ('windows' or 'unix')
to tailor command-line and path separators. (default: unix).

2
website/content/partials/builder/amazon/common/RunConfig-not-required.mdx
Unescape View File

@ -15,7 +15,7 @@
- `disable_stop_instance` (bool) - Packer normally stops the build instance after all provisioners have
run. For Windows instances, it is sometimes desirable to [run
Sysprep](http://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ami-create-standard.html)
Sysprep](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/Creating_EBSbacked_WinAMI.html)
which will stop the instance for you. If this is set to `true`, Packer
*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

6
website/content/partials/builder/azure/arm/Config-required.mdx
Unescape View File

@ -1,20 +1,20 @@
<!-- Code generated from the comments of the Config struct in builder/azure/arm/config.go; DO NOT EDIT MANUALLY -->
- `image_publisher` (string) - Name of the publisher to use for your base image (Azure Marketplace Images only). See
[documentation](https://azure.microsoft.com/en-us/documentation/articles/resource-groups-vm-searching/)
[documentation](https://docs.microsoft.com/en-us/cli/azure/vm/image)
for details.
CLI example `az vm image list-publishers --location westus`
- `image_offer` (string) - Name of the publisher's offer to use for your base image (Azure Marketplace Images only). See
[documentation](https://azure.microsoft.com/en-us/documentation/articles/resource-groups-vm-searching/)
[documentation](https://docs.microsoft.com/en-us/cli/azure/vm/image)
for details.
CLI example
`az vm image list-offers --location westus --publisher Canonical`
- `image_sku` (string) - SKU of the image offer to use for your base image (Azure Marketplace Images only). See
[documentation](https://azure.microsoft.com/en-us/documentation/articles/resource-groups-vm-searching/)
[documentation](https://docs.microsoft.com/en-us/cli/azure/vm/image)
for details.
CLI example

6
website/content/partials/builder/azure/dtl/Config-not-required.mdx
Unescape View File

@ -46,20 +46,20 @@
minutes, and `h` for hours.)
- `image_publisher` (string) - PublisherName for your base image. See
[documentation](https://azure.microsoft.com/en-us/documentation/articles/resource-groups-vm-searching/)
[documentation](https://docs.microsoft.com/en-us/cli/azure/vm/image)
for details.
CLI example `az vm image list-publishers --location westus`
- `image_offer` (string) - Offer for your base image. See
[documentation](https://azure.microsoft.com/en-us/documentation/articles/resource-groups-vm-searching/)
[documentation](https://docs.microsoft.com/en-us/cli/azure/vm/image)
for details.
CLI example
`az vm image list-offers --location westus --publisher Canonical`
- `image_sku` (string) - SKU for your base image. See
[documentation](https://azure.microsoft.com/en-us/documentation/articles/resource-groups-vm-searching/)
[documentation](https://docs.microsoft.com/en-us/cli/azure/vm/image)
for details.
CLI example

2
website/content/partials/builder/vagrant/Config-not-required.mdx
Unescape View File

@ -17,7 +17,7 @@
* ebfb681885ddf1234c18094a45bbeafd91467911
* sha256:ed363350696a726b7932db864dda019bd2017365c9e299627830f06954643f93
* ed363350696a726b7932db864dda019bd2017365c9e299627830f06954643f93
* file:http://releases.ubuntu.com/20.04/MD5SUMS
* file:http://releases.ubuntu.com/20.04/SHA256SUMS
* file:file://./local/path/file.sum
* file:./local/path/file.sum
* none

2
website/content/partials/builder/virtualbox/ovf/Config-required.mdx
Unescape View File

@ -13,7 +13,7 @@
* ebfb681885ddf1234c18094a45bbeafd91467911
* sha256:ed363350696a726b7932db864dda019bd2017365c9e299627830f06954643f93
* ed363350696a726b7932db864dda019bd2017365c9e299627830f06954643f93
* file:http://releases.ubuntu.com/20.04/MD5SUMS
* file:http://releases.ubuntu.com/20.04/SHA256SUMS
* file:file://./local/path/file.sum
* file:./local/path/file.sum
* none

2
website/content/partials/builder/vsphere/common/ConfigParamsConfig-not-required.mdx
Unescape View File

@ -1,7 +1,7 @@
<!-- Code generated from the comments of the ConfigParamsConfig struct in builder/vsphere/common/step_config_params.go; DO NOT EDIT MANUALLY -->
- `configuration_parameters` (map[string]string) - configuration_parameters is a direct passthrough to the VSphere API's
ConfigSpec: https://pubs.vmware.com/vi3/sdk/ReferenceGuide/vim.vm.ConfigSpec.html
ConfigSpec: https://www.vmware.com/support/developer/vc-sdk/visdk41pubs/ApiReference/vim.vm.ConfigSpec.html
- `tools_sync_time` (bool) - Enables time synchronization with the host. Defaults to false.

Write Preview
Loading…
Cancel
Save