Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: add debug info #196

Merged
merged 3 commits into from
Sep 17, 2024
Merged

doc: add debug info #196

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e70d5ce
doc: add debug info
Codelax Sep 17, 2024
c315184
move md file to .github
Codelax Sep 17, 2024
9695fd3
gen doc
Codelax Sep 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions .github/DEBUG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Debug

The recommended way to debug a packer plugin is adding prints and running with logs enabled.
As written in [packer debug documentation](https://developer.hashicorp.com/packer/docs/debugging), you can use `PACKER_LOG=1` to enable verbose logging.

## Testing local build

To test a local build, you need to have the plugin in the same folder where you will run packer:


```
> ls
packer-plugin-scaleway build_scaleway.pkr.hcl
> PACKER_LOG=DEBUG SCW_DEBUG=1 packer build build_scaleway.pkr.hcl
...
```
6 changes: 3 additions & 3 deletions .web-docs/components/builder/scaleway/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,20 +111,20 @@ can also be supplied to override the typical auto-generated key:
It can also be specified via environment variable SCALEWAY_API_TOKEN. You
can see and generate tokens in the "Credentials"
section of the control panel.
Deprecated, use SecretKey instead
Deprecated: use SecretKey instead

- `organization_id` (string) - The organization id to use to identify your
organization. It can also be specified via environment variable
SCALEWAY_ORGANIZATION. Your organization id is available in the
"Account" section of the
control panel.
Previously named: api_access_key with environment variable: SCALEWAY_API_ACCESS_KEY
Deprecated, use ProjectID instead
Deprecated: use ProjectID instead

- `region` (string) - The name of the region to launch the server in (par1
or ams1). Consequently, this is the region where the snapshot will be
available.
Deprecated, use Zone instead
Deprecated: use Zone instead

<!-- End of code generated from the comments of the Config struct in builder/scaleway/config.go; -->

Expand Down
6 changes: 3 additions & 3 deletions docs-partials/builder/scaleway/Config-not-required.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,19 +44,19 @@
It can also be specified via environment variable SCALEWAY_API_TOKEN. You
can see and generate tokens in the "Credentials"
section of the control panel.
Deprecated, use SecretKey instead
Deprecated: use SecretKey instead

- `organization_id` (string) - The organization id to use to identify your
organization. It can also be specified via environment variable
SCALEWAY_ORGANIZATION. Your organization id is available in the
"Account" section of the
control panel.
Previously named: api_access_key with environment variable: SCALEWAY_API_ACCESS_KEY
Deprecated, use ProjectID instead
Deprecated: use ProjectID instead

- `region` (string) - The name of the region to launch the server in (par1
or ams1). Consequently, this is the region where the snapshot will be
available.
Deprecated, use Zone instead
Deprecated: use Zone instead

<!-- End of code generated from the comments of the Config struct in builder/scaleway/config.go; -->
Loading