Skip to content

Commit

Permalink
docs: move new structure to docs-src
Browse files Browse the repository at this point in the history
  • Loading branch information
lbajolet-hashicorp committed Nov 24, 2023
1 parent b20861f commit 1ebfe36
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 557 deletions.
16 changes: 8 additions & 8 deletions .web-docs/components/builder/upcloud/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ The upcloud builder is used to generate storage templates on UpCloud.

<!-- Builder Configuration Fields -->

## Required
### Required

<!-- Code generated from the comments of the Config struct in builder/upcloud/config.go; DO NOT EDIT MANUALLY -->

Expand All @@ -30,7 +30,7 @@ The upcloud builder is used to generate storage templates on UpCloud.
noted in the description of the field
-->

## Optional
### Optional

<!-- Code generated from the comments of the Config struct in builder/upcloud/config.go; DO NOT EDIT MANUALLY -->

Expand Down Expand Up @@ -66,7 +66,7 @@ The upcloud builder is used to generate storage templates on UpCloud.
<!-- End of code generated from the comments of the Config struct in builder/upcloud/config.go; -->


## Network Interfaces object (NetworkInterface)
#### Network Interfaces object (NetworkInterface)

<!-- Code generated from the comments of the NetworkInterface struct in builder/upcloud/config.go; DO NOT EDIT MANUALLY -->

Expand All @@ -79,7 +79,7 @@ The upcloud builder is used to generate storage templates on UpCloud.
<!-- End of code generated from the comments of the NetworkInterface struct in builder/upcloud/config.go; -->


## IP Address object (IPAddress)
#### IP Address object (IPAddress)

<!-- Code generated from the comments of the IPAddress struct in builder/upcloud/config.go; DO NOT EDIT MANUALLY -->

Expand All @@ -98,7 +98,7 @@ The upcloud builder is used to generate storage templates on UpCloud.
can be provided to highlight various build configurations.
-->
## Example Usage
### Example Usage

Here is a sample template, which you can also find in the [example](https://github.com/UpCloudLtd/packer-plugin-upcloud/tree/main/example) directory.
It reads your UpCloud API credentials from the environment variables, creates an Ubuntu 20.04 LTS server in the `nl-ams1` region and authorizes root user to loggin with your public SSH key.
Expand Down Expand Up @@ -159,7 +159,7 @@ Configuration reads your SSH public key from the default location `~/.ssh/id_rsa
$ packer build -var="ssh_public_key=/some/other/path/id_rsa.pub"
```

## Network interfaces
#### Network interfaces
This template uses `network_interfaces` to define network interfaces to be used during the creation of the server for building the packer image.
```hcl
packer {
Expand Down Expand Up @@ -226,7 +226,7 @@ build {
```

## IPv6 network interfaces
#### IPv6 network interfaces
```hcl
packer {
required_plugins {
Expand Down Expand Up @@ -295,7 +295,7 @@ build {
```

## Private network interfaces
#### Private network interfaces
```hcl
packer {
required_plugins {
Expand Down
6 changes: 3 additions & 3 deletions .web-docs/components/post-processor/upcloud-import/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Artifact BuilderId: `packer.post-processor.upcloud-import`

The UpCloud importer can be used to import raw disk images as private templates to UpCloud.

## Required
### Required
Username and password configuration arguments can be omitted if environment variables `UPCLOUD_USERNAME` and `UPCLOUD_PASSWORD` are set.

<!-- Code generated from the comments of the Config struct in post-processor/upcloud-import/config.go; DO NOT EDIT MANUALLY -->
Expand All @@ -21,7 +21,7 @@ Username and password configuration arguments can be omitted if environment vari
<!-- End of code generated from the comments of the Config struct in post-processor/upcloud-import/config.go; -->


## Optional
### Optional

<!-- Code generated from the comments of the Config struct in post-processor/upcloud-import/config.go; DO NOT EDIT MANUALLY -->

Expand All @@ -33,7 +33,7 @@ Username and password configuration arguments can be omitted if environment vari



## Example Usage
### Example Usage

Import raw disk image from filesystem using `compress` post-processor to compress image before upload
```hcl
Expand Down
File renamed without changes.
59 changes: 0 additions & 59 deletions docs-src/README.mdx

This file was deleted.

Loading

0 comments on commit 1ebfe36

Please sign in to comment.