| 1 |
{ |
| 2 |
"$defs": { |
| 3 |
"TYPE_DictOrStringOrListOfStrings": { |
| 4 |
"anyOf": [ |
| 5 |
{ "type": "object" }, |
| 6 |
{ "type": "string" }, |
| 7 |
{ |
| 8 |
"items": { |
| 9 |
"type": "string" |
| 10 |
}, |
| 11 |
"type": "array" |
| 12 |
} |
| 13 |
] |
| 14 |
}, |
| 15 |
"TYPE_StringOrListOfStrings": { |
| 16 |
"anyOf": [ |
| 17 |
{ "type": "string" }, |
| 18 |
{ |
| 19 |
"items": { |
| 20 |
"type": "string" |
| 21 |
}, |
| 22 |
"type": "array" |
| 23 |
} |
| 24 |
] |
| 25 |
}, |
| 26 |
"v1": { |
| 27 |
"additionalProperties": false, |
| 28 |
"properties": { |
| 29 |
"additional_build_steps": { |
| 30 |
"properties": { |
| 31 |
"append": { |
| 32 |
"$ref": "#/$defs/TYPE_StringOrListOfStrings", |
| 33 |
"examples": ["RUN cat /etc/os-release"] |
| 34 |
}, |
| 35 |
"prepend": { |
| 36 |
"$ref": "#/$defs/TYPE_StringOrListOfStrings", |
| 37 |
"examples": ["RUN cat /etc/os-release"] |
| 38 |
} |
| 39 |
}, |
| 40 |
"title": "Commands to append or prepend to container build process.", |
| 41 |
"type": "object" |
| 42 |
}, |
| 43 |
"ansible_config": { |
| 44 |
"examples": ["ansible.cfg"], |
| 45 |
"title": "Ansible configuration file", |
| 46 |
"type": "string" |
| 47 |
}, |
| 48 |
"build_arg_defaults": { |
| 49 |
"additionalProperties": true, |
| 50 |
"properties": { |
| 51 |
"EE_BASE_IMAGE": { |
| 52 |
"type": "string" |
| 53 |
} |
| 54 |
}, |
| 55 |
"type": "object" |
| 56 |
}, |
| 57 |
"dependencies": { |
| 58 |
"description": "Allows adding system, python or galaxy dependencies.", |
| 59 |
"properties": { |
| 60 |
"galaxy": { |
| 61 |
"examples": ["requirements.yml"], |
| 62 |
"markdownDescription": "Example `requirements.yml`", |
| 63 |
"title": "Optional galaxy file", |
| 64 |
"type": "string" |
| 65 |
}, |
| 66 |
"python": { |
| 67 |
"examples": ["requirements.txt"], |
| 68 |
"markdownDescription": "Example `requirements.txt`", |
| 69 |
"title": "Optional python package dependencies", |
| 70 |
"type": "string" |
| 71 |
}, |
| 72 |
"system": { |
| 73 |
"examples": ["bindep.txt"], |
| 74 |
"markdownDescription": "Example `bindep.txt`", |
| 75 |
"title": "Optional system dependencies using bindep format", |
| 76 |
"type": "string" |
| 77 |
} |
| 78 |
}, |
| 79 |
"title": "Dependencies", |
| 80 |
"type": "object" |
| 81 |
}, |
| 82 |
"version": { |
| 83 |
"enum": [1], |
| 84 |
"title": "Version", |
| 85 |
"type": "integer" |
| 86 |
} |
| 87 |
}, |
| 88 |
"required": ["version", "dependencies"], |
| 89 |
"title": "Ansible Execution Environment Schema v1", |
| 90 |
"type": "object" |
| 91 |
}, |
| 92 |
"v3": { |
| 93 |
"additionalProperties": false, |
| 94 |
"properties": { |
| 95 |
"additional_build_files": { |
| 96 |
"description": "Describes files to add to the build context", |
| 97 |
"items": { |
| 98 |
"additionalProperties": false, |
| 99 |
"properties": { |
| 100 |
"dest": { |
| 101 |
"description": "Relative subdirectory under build context to place file", |
| 102 |
"type": "string" |
| 103 |
}, |
| 104 |
"src": { |
| 105 |
"description": "File to add to build context", |
| 106 |
"type": "string" |
| 107 |
} |
| 108 |
}, |
| 109 |
"required": ["src", "dest"], |
| 110 |
"type": "object" |
| 111 |
}, |
| 112 |
"type": "array" |
| 113 |
}, |
| 114 |
"additional_build_steps": { |
| 115 |
"properties": { |
| 116 |
"append_base": { |
| 117 |
"$ref": "#/$defs/TYPE_StringOrListOfStrings", |
| 118 |
"examples": ["RUN cat /etc/os-release"] |
| 119 |
}, |
| 120 |
"append_builder": { |
| 121 |
"$ref": "#/$defs/TYPE_StringOrListOfStrings", |
| 122 |
"examples": ["RUN cat /etc/os-release"] |
| 123 |
}, |
| 124 |
"append_final": { |
| 125 |
"$ref": "#/$defs/TYPE_StringOrListOfStrings", |
| 126 |
"examples": ["RUN cat /etc/os-release"] |
| 127 |
}, |
| 128 |
"append_galaxy": { |
| 129 |
"$ref": "#/$defs/TYPE_StringOrListOfStrings", |
| 130 |
"examples": ["RUN cat /etc/os-release"] |
| 131 |
}, |
| 132 |
"prepend_base": { |
| 133 |
"$ref": "#/$defs/TYPE_StringOrListOfStrings", |
| 134 |
"examples": ["RUN cat /etc/os-release"] |
| 135 |
}, |
| 136 |
"prepend_builder": { |
| 137 |
"$ref": "#/$defs/TYPE_StringOrListOfStrings", |
| 138 |
"examples": ["RUN cat /etc/os-release"] |
| 139 |
}, |
| 140 |
"prepend_final": { |
| 141 |
"$ref": "#/$defs/TYPE_StringOrListOfStrings", |
| 142 |
"examples": ["RUN cat /etc/os-release"] |
| 143 |
}, |
| 144 |
"prepend_galaxy": { |
| 145 |
"$ref": "#/$defs/TYPE_StringOrListOfStrings", |
| 146 |
"examples": ["RUN cat /etc/os-release"] |
| 147 |
} |
| 148 |
}, |
| 149 |
"title": "Commands to append or prepend to container build process.", |
| 150 |
"type": "object" |
| 151 |
}, |
| 152 |
"build_arg_defaults": { |
| 153 |
"additionalProperties": false, |
| 154 |
"properties": { |
| 155 |
"ANSIBLE_GALAXY_CLI_COLLECTION_OPTS": { |
| 156 |
"type": "string" |
| 157 |
}, |
| 158 |
"ANSIBLE_GALAXY_CLI_ROLE_OPTS": { |
| 159 |
"type": "string" |
| 160 |
}, |
| 161 |
"PKGMGR_PRESERVE_CACHE": { |
| 162 |
"type": "string" |
| 163 |
} |
| 164 |
}, |
| 165 |
"type": "object" |
| 166 |
}, |
| 167 |
"dependencies": { |
| 168 |
"description": "Allows adding system, python or galaxy dependencies.", |
| 169 |
"properties": { |
| 170 |
"ansible_core": { |
| 171 |
"additionalProperties": false, |
| 172 |
"description": "Ansible package installation", |
| 173 |
"oneOf": [{ "required": ["package_pip"] }], |
| 174 |
"properties": { |
| 175 |
"package_pip": { |
| 176 |
"description": "Ansible package to install via pip", |
| 177 |
"type": "string" |
| 178 |
} |
| 179 |
}, |
| 180 |
"type": "object" |
| 181 |
}, |
| 182 |
"ansible_runner": { |
| 183 |
"additionalProperties": false, |
| 184 |
"description": "Ansible Runner package installation", |
| 185 |
"oneOf": [{ "required": ["package_pip"] }], |
| 186 |
"properties": { |
| 187 |
"package_pip": { |
| 188 |
"description": "Ansible Runner package to install via pip", |
| 189 |
"type": "string" |
| 190 |
} |
| 191 |
}, |
| 192 |
"type": "object" |
| 193 |
}, |
| 194 |
"galaxy": { |
| 195 |
"$ref": "#/$defs/TYPE_DictOrStringOrListOfStrings", |
| 196 |
"examples": ["requirements.yml"], |
| 197 |
"markdownDescription": "Example `requirements.yml`", |
| 198 |
"title": "Optional galaxy file" |
| 199 |
}, |
| 200 |
"python": { |
| 201 |
"$ref": "#/$defs/TYPE_StringOrListOfStrings", |
| 202 |
"examples": ["requirements.txt"], |
| 203 |
"markdownDescription": "Example `requirements.txt`", |
| 204 |
"title": "Optional python package dependencies" |
| 205 |
}, |
| 206 |
"python_interpreter": { |
| 207 |
"additionalProperties": false, |
| 208 |
"description": "Python package name and path", |
| 209 |
"properties": { |
| 210 |
"package_system": { |
| 211 |
"description": "The python package to install via system package manager", |
| 212 |
"type": "string" |
| 213 |
}, |
| 214 |
"python_path": { |
| 215 |
"description": "Path to the python interpreter", |
| 216 |
"type": "string" |
| 217 |
} |
| 218 |
}, |
| 219 |
"type": "object" |
| 220 |
}, |
| 221 |
"system": { |
| 222 |
"$ref": "#/$defs/TYPE_StringOrListOfStrings", |
| 223 |
"examples": ["bindep.txt"], |
| 224 |
"markdownDescription": "Example `bindep.txt`", |
| 225 |
"title": "Optional system dependencies using bindep format" |
| 226 |
} |
| 227 |
}, |
| 228 |
"title": "Dependencies", |
| 229 |
"type": "object" |
| 230 |
}, |
| 231 |
"images": { |
| 232 |
"additionalProperties": false, |
| 233 |
"properties": { |
| 234 |
"base_image": { |
| 235 |
"name": { |
| 236 |
"examples": [ |
| 237 |
"registry.redhat.io/ansible-automation-platform-21/ee-minimal-rhel8:latest" |
| 238 |
], |
| 239 |
"type": "string" |
| 240 |
}, |
| 241 |
"type": "object" |
| 242 |
} |
| 243 |
}, |
| 244 |
"type": "object" |
| 245 |
}, |
| 246 |
"options": { |
| 247 |
"additionalProperties": false, |
| 248 |
"description": "Options that effect runtime behavior", |
| 249 |
"properties": { |
| 250 |
"container_init": { |
| 251 |
"additionalProperties": false, |
| 252 |
"description": "Customize container startup behavior", |
| 253 |
"properties": { |
| 254 |
"cmd": { |
| 255 |
"description": "literal value for CMD Containerfile directive", |
| 256 |
"type": "string" |
| 257 |
}, |
| 258 |
"entrypoint": { |
| 259 |
"description": "literal value for ENTRYPOINT Containerfile directive", |
| 260 |
"type": "string" |
| 261 |
}, |
| 262 |
"package_pip": { |
| 263 |
"description": "package to install via pip for entrypoint support", |
| 264 |
"type": "string" |
| 265 |
} |
| 266 |
}, |
| 267 |
"type": "object" |
| 268 |
}, |
| 269 |
"package_manager_path": { |
| 270 |
"description": "Path to the system package manager to use", |
| 271 |
"type": "string" |
| 272 |
}, |
| 273 |
"relax_passwd_permissions": { |
| 274 |
"description": "allows GID0 write access to /etc/passwd; currently necessary for many uses", |
| 275 |
"type": "boolean" |
| 276 |
}, |
| 277 |
"skip_ansible_check": { |
| 278 |
"description": "Disables the check for Ansible/Runner in final image", |
| 279 |
"type": "boolean" |
| 280 |
}, |
| 281 |
"skip_pip_install": { |
| 282 |
"description": "Disables the installation of pip in the base image", |
| 283 |
"type": "boolean" |
| 284 |
}, |
| 285 |
"user": { |
| 286 |
"description": "Sets the username or UID", |
| 287 |
"type": "string" |
| 288 |
}, |
| 289 |
"workdir": { |
| 290 |
"description": "Default working directory, also often the homedir for ephemeral UIDs", |
| 291 |
"type": ["string", "null"] |
| 292 |
}, |
| 293 |
"tags": { |
| 294 |
"description": "A list of names to assign to the resulting image if build process completes successfully", |
| 295 |
"type": "array", |
| 296 |
"items": { |
| 297 |
"type": "string" |
| 298 |
} |
| 299 |
} |
| 300 |
}, |
| 301 |
"type": "object" |
| 302 |
}, |
| 303 |
"version": { |
| 304 |
"enum": [3], |
| 305 |
"title": "Version", |
| 306 |
"type": "integer" |
| 307 |
} |
| 308 |
}, |
| 309 |
"required": ["version", "dependencies"], |
| 310 |
"title": "Ansible Execution Environment Schema v3", |
| 311 |
"type": "object" |
| 312 |
} |
| 313 |
}, |
| 314 |
"$id": "https://raw.githubusercontent.com/ansible/ansible-lint/main/src/ansiblelint/schemas/execution-environment.json", |
| 315 |
"$schema": "http://json-schema.org/draft-07/schema", |
| 316 |
"description": "See https://docs.ansible.com/projects/builder/en/latest/definition/ for V3 or https://legacy-controller-docs.ansible.com/automation-controller/ for older V1 format.\n", |
| 317 |
"documentation_url": "https://docs.ansible.com/projects/builder/en/latest/definition/", |
| 318 |
"examples": ["execution-environment.yml"], |
| 319 |
"oneOf": [{ "$ref": "#/$defs/v3" }, { "$ref": "#/$defs/v1" }], |
| 320 |
"title": "Ansible Execution Environment Schema v1/v3" |
| 321 |
} |