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

YAML align indent sizes for docs readability #323

Merged
merged 5 commits into from
Apr 22, 2020
Merged

YAML align indent sizes for docs readability #323

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2520816
docs: align indent sizes of YAML
nishigori Apr 19, 2020
178f08a
More cla signers
nishigori Apr 21, 2020
476303f
Fix indent alignment of list
nishigori Apr 22, 2020
7fb5957
Fix indent of '|' content
nishigori Apr 22, 2020
dea42be
Merge branch 'master' into align-yaml-indent-size
OddBloke Apr 22, 2020
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
42 changes: 21 additions & 21 deletions doc/examples/cloud-config-apt.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ apt:
# as above, allowing to have one config for different per arch mirrors
# security is optional, if not defined it is set to the same value as primary
security:
uri: http://security.ubuntu.com/ubuntu
uri: http://security.ubuntu.com/ubuntu
# If search_dns is set for security the searched pattern is:
# <distro>-security-mirror

Expand Down Expand Up @@ -222,19 +222,19 @@ apt:
# This allows merging between multiple input files than a list like:
# cloud-config1
# sources:
# s1: {'key': 'key1', 'source': 'source1'}
# s1: {'key': 'key1', 'source': 'source1'}
# cloud-config2
# sources:
# s2: {'key': 'key2'}
# s1: {'keyserver': 'foo'}
# s2: {'key': 'key2'}
# s1: {'keyserver': 'foo'}
# This would be merged to
# sources:
# s1:
# keyserver: foo
# key: key1
# source: source1
# s2:
# key: key2
# s1:
# keyserver: foo
# key: key1
# source: source1
# s2:
# key: key2
#
# The following examples number the subfeatures per sources entry to ease
# identification in discussions.
Expand Down Expand Up @@ -314,15 +314,15 @@ apt:
# As with keyid's this can be specified with or without some actual source
# content.
key: | # The value needs to start with -----BEGIN PGP PUBLIC KEY BLOCK-----
-----BEGIN PGP PUBLIC KEY BLOCK-----
Version: SKS 1.0.10
-----BEGIN PGP PUBLIC KEY BLOCK-----
Version: SKS 1.0.10

mI0ESpA3UQEEALdZKVIMq0j6qWAXAyxSlF63SvPVIgxHPb9Nk0DZUixn+akqytxG4zKCONz6
qLjoBBfHnynyVLfT4ihg9an1PqxRnTO+JKQxl8NgKGz6Pon569GtAOdWNKw15XKinJTDLjnj
9y96ljJqRcpV9t/WsIcdJPcKFR5voHTEoABE2aEXABEBAAG0GUxhdW5jaHBhZCBQUEEgZm9y
IEFsZXN0aWOItgQTAQIAIAUCSpA3UQIbAwYLCQgHAwIEFQIIAwQWAgMBAh4BAheAAAoJEA7H
5Qi+CcVxWZ8D/1MyYvfj3FJPZUm2Yo1zZsQ657vHI9+pPouqflWOayRR9jbiyUFIn0VdQBrP
t0FwvnOFArUovUWoKAEdqR8hPy3M3APUZjl5K4cMZR/xaMQeQRZ5CHpS4DBKURKAHC0ltS5o
uBJKQOZm5iltJp15cgyIkBkGe8Mx18VFyVglAZey
=Y2oI
-----END PGP PUBLIC KEY BLOCK-----
mI0ESpA3UQEEALdZKVIMq0j6qWAXAyxSlF63SvPVIgxHPb9Nk0DZUixn+akqytxG4zKCONz6
qLjoBBfHnynyVLfT4ihg9an1PqxRnTO+JKQxl8NgKGz6Pon569GtAOdWNKw15XKinJTDLjnj
9y96ljJqRcpV9t/WsIcdJPcKFR5voHTEoABE2aEXABEBAAG0GUxhdW5jaHBhZCBQUEEgZm9y
IEFsZXN0aWOItgQTAQIAIAUCSpA3UQIbAwYLCQgHAwIEFQIIAwQWAgMBAh4BAheAAAoJEA7H
5Qi+CcVxWZ8D/1MyYvfj3FJPZUm2Yo1zZsQ657vHI9+pPouqflWOayRR9jbiyUFIn0VdQBrP
t0FwvnOFArUovUWoKAEdqR8hPy3M3APUZjl5K4cMZR/xaMQeQRZ5CHpS4DBKURKAHC0ltS5o
uBJKQOZm5iltJp15cgyIkBkGe8Mx18VFyVglAZey
=Y2oI
-----END PGP PUBLIC KEY BLOCK-----
4 changes: 2 additions & 2 deletions doc/examples/cloud-config-boot-cmds.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@
# - the INSTANCE_ID variable will be set to the current instance id.
# - you can use 'cloud-init-per' command to help only run once
bootcmd:
- echo 192.168.1.130 us.archive.ubuntu.com >> /etc/hosts
- [ cloud-init-per, once, mymkfs, mkfs, /dev/vdb ]
- echo 192.168.1.130 us.archive.ubuntu.com >> /etc/hosts
- [ cloud-init-per, once, mymkfs, mkfs, /dev/vdb ]
52 changes: 26 additions & 26 deletions doc/examples/cloud-config-chef-oneiric.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,38 +48,38 @@ apt:

chef:

# 11.10 will fail if install_type is "gems" (LP: #960576)
install_type: "packages"
# 11.10 will fail if install_type is "gems" (LP: #960576)
install_type: "packages"

# Chef settings
server_url: "https://chef.yourorg.com:4000"
# Chef settings
server_url: "https://chef.yourorg.com:4000"

# Node Name
# Defaults to the instance-id if not present
node_name: "your-node-name"
# Node Name
# Defaults to the instance-id if not present
node_name: "your-node-name"

# Environment
# Defaults to '_default' if not present
environment: "production"
# Environment
# Defaults to '_default' if not present
environment: "production"

# Default validation name is chef-validator
validation_name: "yourorg-validator"
# Default validation name is chef-validator
validation_name: "yourorg-validator"

# value of validation_cert is not used if validation_key defined,
# but variable needs to be defined (LP: #960547)
validation_cert: "unused"
validation_key: |
-----BEGIN RSA PRIVATE KEY-----
YOUR-ORGS-VALIDATION-KEY-HERE
-----END RSA PRIVATE KEY-----

# A run list for a first boot json
run_list:
- "recipe[apache2]"
- "role[db]"
# value of validation_cert is not used if validation_key defined,
# but variable needs to be defined (LP: #960547)
validation_cert: "unused"
validation_key: |
-----BEGIN RSA PRIVATE KEY-----
YOUR-ORGS-VALIDATION-KEY-HERE
-----END RSA PRIVATE KEY-----

# Specify a list of initial attributes used by the cookbooks
initial_attributes:
# A run list for a first boot json
run_list:
- "recipe[apache2]"
- "role[db]"

# Specify a list of initial attributes used by the cookbooks
initial_attributes:
apache:
prefork:
maxclients: 100
Expand Down
84 changes: 42 additions & 42 deletions doc/examples/cloud-config-chef.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,55 +52,55 @@ apt:

chef:

# Valid values are 'gems' and 'packages' and 'omnibus'
install_type: "packages"

# Boolean: run 'install_type' code even if chef-client
# appears already installed.
force_install: false

# Chef settings
server_url: "https://chef.yourorg.com"

# Node Name
# Defaults to the instance-id if not present
node_name: "your-node-name"

# Environment
# Defaults to '_default' if not present
environment: "production"

# Default validation name is chef-validator
validation_name: "yourorg-validator"
# if validation_cert's value is "system" then it is expected
# that the file already exists on the system.
validation_cert: |
-----BEGIN RSA PRIVATE KEY-----
YOUR-ORGS-VALIDATION-KEY-HERE
-----END RSA PRIVATE KEY-----

# A run list for a first boot json, an example (not required)
run_list:
- "recipe[apache2]"
- "role[db]"

# Specify a list of initial attributes used by the cookbooks
initial_attributes:
# Valid values are 'gems' and 'packages' and 'omnibus'
install_type: "packages"

# Boolean: run 'install_type' code even if chef-client
# appears already installed.
force_install: false

# Chef settings
server_url: "https://chef.yourorg.com"

# Node Name
# Defaults to the instance-id if not present
node_name: "your-node-name"

# Environment
# Defaults to '_default' if not present
environment: "production"

# Default validation name is chef-validator
validation_name: "yourorg-validator"
# if validation_cert's value is "system" then it is expected
# that the file already exists on the system.
validation_cert: |
-----BEGIN RSA PRIVATE KEY-----
YOUR-ORGS-VALIDATION-KEY-HERE
-----END RSA PRIVATE KEY-----

# A run list for a first boot json, an example (not required)
run_list:
- "recipe[apache2]"
- "role[db]"

# Specify a list of initial attributes used by the cookbooks
initial_attributes:
apache:
prefork:
maxclients: 100
keepalive: "off"

# if install_type is 'omnibus', change the url to download
omnibus_url: "https://www.chef.io/chef/install.sh"
# if install_type is 'omnibus', change the url to download
omnibus_url: "https://www.chef.io/chef/install.sh"

# if install_type is 'omnibus', pass pinned version string
# to the install script
omnibus_version: "12.3.0"
# if install_type is 'omnibus', pass pinned version string
# to the install script
omnibus_version: "12.3.0"

# If encrypted data bags are used, the client needs to have a secrets file
# configured to decrypt them
encrypted_data_bag_secret: "/etc/chef/encrypted_data_bag_secret"
# If encrypted data bags are used, the client needs to have a secrets file
# configured to decrypt them
encrypted_data_bag_secret: "/etc/chef/encrypted_data_bag_secret"

# Capture all subprocess output into a logfile
# Useful for troubleshooting cloud-init issues
Expand Down
6 changes: 3 additions & 3 deletions doc/examples/cloud-config-datasources.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,10 @@ datasource:
# these are optional, but allow you to basically provide a datasource
# right here
user-data: |
# This is the user-data verbatim
# This is the user-data verbatim
meta-data:
instance-id: i-87018aed
local-hostname: myhost.internal
instance-id: i-87018aed
local-hostname: myhost.internal

Azure:
agent_command: [service, walinuxagent, start]
Expand Down
Loading