chore: fix yaml sample
This commit is contained in:
parent
f12e22bca2
commit
795e34363f
73
README.md
73
README.md
@ -188,7 +188,7 @@ make show_coverage
|
||||
|
||||
- That's all! 🎉
|
||||
|
||||
## YAML Config Example
|
||||
## YAML resources declaration
|
||||
|
||||
```yaml
|
||||
# Controller to manage and monitor
|
||||
@ -213,8 +213,8 @@ mainName: main-name
|
||||
provider: upcloud
|
||||
resolvDNS: ''
|
||||
servers:
|
||||
# Apps to install
|
||||
- apps:
|
||||
# Repeat this section for each host
|
||||
- apps: # Apps to install
|
||||
- critical: no
|
||||
liveness: ''
|
||||
name: none
|
||||
@ -240,14 +240,12 @@ servers:
|
||||
- access: public
|
||||
family: IPv4
|
||||
source_ip_filtering: yes
|
||||
# If use SDN
|
||||
- access: private
|
||||
- access: private # If use SDN
|
||||
family: IPv4
|
||||
ipaddress: 'ip-for-sdn'
|
||||
network: "sdn-uuid"
|
||||
source_ip_filtering: no
|
||||
# UpCloud server plan
|
||||
plan: "1xCPU-1GB"
|
||||
plan: "1xCPU-1GB" # UpCloud server plan
|
||||
rules:
|
||||
- ''
|
||||
sshAccess:
|
||||
@ -260,8 +258,7 @@ servers:
|
||||
storages:
|
||||
- action: clone
|
||||
size: 20
|
||||
# this can be used to create partitions
|
||||
finalSize: 20
|
||||
finalSize: 20 # These 3 lines can be used to create partitions
|
||||
makefs: ""
|
||||
partSizes: ''
|
||||
source: source-name
|
||||
@ -273,8 +270,7 @@ servers:
|
||||
- ci
|
||||
timeZone: UTC
|
||||
title: titls-of-this-host
|
||||
# Tasks & Services to install,maintain,monitor, etc.
|
||||
tsksrvcs:
|
||||
tsksrvcs: # Tasks & Services to install,maintain,monitor, etc.
|
||||
- critical: no
|
||||
liveness: ''
|
||||
name: sysconfig
|
||||
@ -283,60 +279,7 @@ servers:
|
||||
target: ''
|
||||
useFloatIP: false
|
||||
userData: ''
|
||||
# UpCloud Zone
|
||||
zone: es-mad1
|
||||
|
||||
floatIP: float-ip-for-servers
|
||||
# "hostname" should start with hostPrefix or comment/remove this setting
|
||||
hostPrefix: prefix-for-severs
|
||||
# Could be same as hostPrefix, like "server" for server01, server02, etc
|
||||
mainName: main-global/cluster/floatIP-name
|
||||
servers:
|
||||
# Repeat this section for each host
|
||||
- hostname: test.example.com
|
||||
title: "Host title"
|
||||
# Cluster definition for this server not mandatory
|
||||
cluster:
|
||||
role: master # role in ansible inventory
|
||||
## SSH credentials to run commands not mandatory
|
||||
ssh:
|
||||
host: hostName-or-ip
|
||||
user: root
|
||||
password: ""
|
||||
type: key # can use password
|
||||
keyPath: path-to-id_rsa-key-file
|
||||
port: 22
|
||||
# List of Tags (management can be restricted for user account)
|
||||
tags:
|
||||
- server
|
||||
loginUser:
|
||||
sshKeys: # ssh-rsa public keys to add
|
||||
- ssh-rsa ....
|
||||
plan: "1xCPU-1GB" # UpCloud Plan if is using an UpCloud "Simple Plan"
|
||||
metaData: 1
|
||||
timeZone: "UTC"
|
||||
userData: ""
|
||||
zone: nl-ams1 # UpCloud Zone
|
||||
|
||||
# List of Storage Devices, at least one
|
||||
storageDevices:
|
||||
- action: clone # UpCloud Storage Action
|
||||
title: "storage-title"
|
||||
storage: "UpCloud Storage UUID"
|
||||
size: 25 # Volume Size in GB
|
||||
tier: maxiops
|
||||
# If this sever can use floatIP set to 1
|
||||
useFloatIP: 1
|
||||
# List of Networks, at least one
|
||||
networks:
|
||||
- access: utility # only if is need it
|
||||
family: IPv4
|
||||
- access: public # only if is need it
|
||||
family: IPv4
|
||||
- access: private # if is going to use SDN or remove
|
||||
family: IPv4
|
||||
network: UUID-SDN-NETWORK
|
||||
ipaddress: SDN-ip-address-or-use-SDN-DHCP
|
||||
zone: es-mad1 # UpCloud Zone
|
||||
|
||||
```
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user