addons

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

Overview

Name	addons
Type	Resource
Id	oci.container_engine.addons

Fields

The following fields are returned by SELECT queries:

get

Addon details.

Name	Datatype	Description
name	string	The name of the addon. (example: flannel)
addonError	object	The error info of the addon.
configurations	array	Addon configuration details.
currentInstalledVersion	string	current installed version of the addon (example: x.y.z)
lifecycleState	string	The state of the addon. (CREATING, ACTIVE, DELETING, DELETED, UPDATING, NEEDS_ATTENTION, FAILED) (example: UPDATING, x-obmcs-top-level-enum: #/definitions/AddonLifecycleState)
timeCreated	string (date-time)	The time the cluster was created. (example: 2017-07-21T16:11:29Z)
version	string	selected addon version, or null indicates autoUpdate (example: x.y.z)

list

The properties that define an addon summary.

Name	Datatype	Description
name	string	The name of the addon. (example: Flannel)
addonError	object	The error info of the addon.
currentInstalledVersion	string	current installed version of the addon (example: x.y.z)
lifecycleState	string	The state of the addon. (CREATING, ACTIVE, DELETING, DELETED, UPDATING, NEEDS_ATTENTION, FAILED) (example: UPDATING, x-obmcs-top-level-enum: #/definitions/AddonLifecycleState)
timeCreated	string (date-time)	The time the cluster was created. (example: 2017-07-21T16:11:29Z)
version	string	selected addon version, or null indicates autoUpdate (example: x.y.z)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	clusterId, addonName, region	opc-request-id	Get the specified addon for a cluster.
list	select	clusterId, region	opc-request-id, limit, page, sortOrder, sortBy	List addon for a provisioned cluster.
update	update	clusterId, addonName, region	if-match, opc-request-id	Update addon details for a cluster.
install_addon	exec	clusterId, region, addonName	opc-retry-token, opc-request-id, if-match	Install the specified addon for a cluster.
disable_addon	exec	clusterId, addonName, isRemoveExistingAddOn, region	if-match, opc-request-id	Disable addon for a provisioned cluster.

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
addonName	string	The name of the addon.
clusterId	string	The OCID of the cluster.
isRemoveExistingAddOn	boolean	Whether existing addon resources should be deleted or not. True would remove the underlying resources completely.
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)
if-match	string	For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
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.
opc-retry-token	string	A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.
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).
sortBy	string	The optional field to sort the results by.
sortOrder	string	The optional order in which to sort the results.

SELECT examples

get

Get the specified addon for a cluster.

SELECT
name,
addonError,
configurations,
currentInstalledVersion,
lifecycleState,
timeCreated,
version
FROM oci.container_engine.addons
WHERE clusterId = '{{ clusterId }}' -- required
AND addonName = '{{ addonName }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

list

List addon for a provisioned cluster.

SELECT
name,
addonError,
currentInstalledVersion,
lifecycleState,
timeCreated,
version
FROM oci.container_engine.addons
WHERE clusterId = '{{ clusterId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND sortOrder = '{{ sortOrder }}'
AND sortBy = '{{ sortBy }}'
;

UPDATE examples

update

Update addon details for a cluster.

UPDATE oci.container_engine.addons
SET 
configurations = '{{ configurations }}',
version = '{{ version }}'
WHERE 
clusterId = '{{ clusterId }}' --required
AND addonName = '{{ addonName }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match}}'
AND opc-request-id = '{{ opc-request-id}}';

Lifecycle Methods

install_addon

Install the specified addon for a cluster.

EXEC oci.container_engine.addons.install_addon 
@clusterId='{{ clusterId }}' --required, 
@region='{{ region }}' --required, 
@opc-retry-token='{{ opc-retry-token }}', 
@opc-request-id='{{ opc-request-id }}', 
@if-match='{{ if-match }}' 
@@json=
'{
"addonName": "{{ addonName }}", 
"configurations": "{{ configurations }}", 
"isOverrideExisting": {{ isOverrideExisting }}, 
"version": "{{ version }}"
}'
;

disable_addon

Disable addon for a provisioned cluster.

EXEC oci.container_engine.addons.disable_addon 
@clusterId='{{ clusterId }}' --required, 
@addonName='{{ addonName }}' --required, 
@isRemoveExistingAddOn='{{ isRemoveExistingAddOn }}' --required, 
@region='{{ region }}' --required, 
@if-match='{{ if-match }}', 
@opc-request-id='{{ opc-request-id }}'
;