addon_options

Creates, updates, deletes, gets or lists an addon_options resource.

Overview

Name	addon_options
Type	Resource
Id	oci.container_engine.addon_options

Fields

The following fields are returned by SELECT queries:

list

The properties that define addon summary.

Name	Datatype	Description
name	string	Name of the addon and it would be unique. (example: flannel)
addonGroup	string	Addon group info, a namespace concept that groups addons with similar functionalities. (example: oke/cluster-network)
addonSchemaVersion	string	Addon definition schema version to validate addon. (example: 0.1)
definedTags	object	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}}
description	string	Description on the addon. (example: BlaBla)
freeformTags	object	Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"}
isEssential	boolean	Is it an essential addon for cluster operation or not.
lifecycleState	string	The life cycle state of the addon. (ACTIVE, INACTIVE) (example: ACTIVE)
systemTags	object	Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}}
timeCreated	string (date-time)	The time the work request was created. (example: 2017-07-21T16:11:29Z)
versions	array	The resources this work request affects.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	kubernetesVersion, region	addonName, opc-request-id, limit, page, sortOrder, sortBy, shouldShowAllVersions	Get list of supported addons for a specific kubernetes version.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
kubernetesVersion	string	The kubernetes version to fetch the addons.
region	string	OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
addonName	string	The name of the addon.
limit	integer	For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. 1 is the minimum, 1000 is the maximum. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
opc-request-id	string	Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
page	string	For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
shouldShowAllVersions	boolean	Specifies whether all add-on versions should be displayed. The default value is false. If set to true, the API will return all available add-on versions, including deprecated versions and detailed build numbers. Please note that the use of deprecated versions, as well as the specification of a particular build of a supported version, is not recommended for standard operations.
sortBy	string	The optional field to sort the results by.
sortOrder	string	The optional order in which to sort the results.

SELECT examples

list

Get list of supported addons for a specific kubernetes version.

SELECT
name,
addonGroup,
addonSchemaVersion,
definedTags,
description,
freeformTags,
isEssential,
lifecycleState,
systemTags,
timeCreated,
versions
FROM oci.container_engine.addon_options
WHERE kubernetesVersion = '{{ kubernetesVersion }}' -- required
AND region = '{{ region }}' -- required
AND addonName = '{{ addonName }}'
AND opc-request-id = '{{ opc-request-id }}'
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND sortOrder = '{{ sortOrder }}'
AND sortBy = '{{ sortBy }}'
AND shouldShowAllVersions = '{{ shouldShowAllVersions }}'
;