Skip to content

BZ#1889248: Add gcp licenses parameter description #37422

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

Merged
adellape merged 1 commit into from
Oct 26, 2021
Merged

BZ#1889248: Add gcp licenses parameter description #37422

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 9 additions & 1 deletion modules/installation-configuration-parameters.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -909,7 +909,7 @@ ifdef::gcp[]
Additional GCP configuration parameters are described in the following table:

.Additional GCP parameters
[cols=".^2,.^3a,.^3a",options="header"]
[cols=".^1,.^6a,.^3a",options="header"]
|====
|Parameter|Description|Values

Expand Down Expand Up @@ -938,6 +938,14 @@ link:https://yaml.org/spec/1.2/spec.html#sequence//[YAML sequence].
|The name of the existing subnet in your VPC that you want to deploy your compute machines to.
|The subnet name.

|`platform.gcp.licenses`
Comment thread
jldohmann marked this conversation as resolved.
Outdated
|A list of license URLs that must be applied to the compute images.
[IMPORTANT]
Copy link
Copy Markdown
Contributor

@michaelryanpeter michaelryanpeter Oct 25, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is rendering weird in the browser. I get that this needs an admonition. Could you try making the column wider?

Copy link
Copy Markdown
Contributor Author

@jldohmann jldohmann Oct 26, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was able to adjust the columns widths, though the changes in the first column seem be unaffected, and the only noticeable column changes are columns two and three.

Copy link
Copy Markdown
Contributor

@adellape adellape Oct 26, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The first column is unaffected thanks to entries like controlPlane.platform.gcp.osDisk.encryptionKey.kmsKey.projectID being so long and unable to wrap when in backticks.

Copy link
Copy Markdown
Contributor

@adellape adellape Oct 26, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Passing thought: It would be outside of the scope of this PR, but since a lot of these parameter names are so long (which messes with the colwidths), it might be worth considering converting this table to a definition list. Would give more wiggle room for more complex usage like mixing in admonition blocks. However, looks like there are lots of similar tables in use in these assemblies, so might be weird / not worth it to mix tables/definition lists. 🤷

But something like:

Screenshot from 2021-10-26 11-10-59

Passing thought ended

====
The `licenses` parameter is a deprecated field and nested virtualization is enabled by default. It is not recommended to use this field.
====
|Any license available with the link:https://cloud.google.com/compute/docs/reference/rest/v1/licenses/list[license API], such as the license to enable link:https://cloud.google.com/compute/docs/instances/nested-virtualization/overview[nested virtualization]. You cannot use this parameter with a mechanism that generates pre-built images. Using a license URL forces the installer to copy the source image before use.

|`platform.gcp.osDisk.diskSizeGB`
|The size of the disk in gigabytes (GB).
|Any size between 16 GB and 65536 GB.
Expand Down