1. Packages
  2. Cilium
  3. API Docs
  4. Install
Cilium v0.1.7 published on Sunday, Sep 29, 2024 by littlejo

cilium.Install

Explore with Pulumi AI

Create Install Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Install(name: string, args?: InstallArgs, opts?: CustomResourceOptions);
@overload
def Install(resource_name: str,
            args: Optional[InstallArgs] = None,
            opts: Optional[ResourceOptions] = None)

@overload
def Install(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            data_path: Optional[str] = None,
            repository: Optional[str] = None,
            reset: Optional[bool] = None,
            reuse: Optional[bool] = None,
            sets: Optional[Sequence[str]] = None,
            values: Optional[str] = None,
            version: Optional[str] = None,
            wait: Optional[bool] = None)
func NewInstall(ctx *Context, name string, args *InstallArgs, opts ...ResourceOption) (*Install, error)
public Install(string name, InstallArgs? args = null, CustomResourceOptions? opts = null)
public Install(String name, InstallArgs args)
public Install(String name, InstallArgs args, CustomResourceOptions options)
type: cilium:Install
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args InstallArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args InstallArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args InstallArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args InstallArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. InstallArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var installResource = new Cilium.Install("installResource", new()
{
    DataPath = "string",
    Repository = "string",
    Reset = false,
    Reuse = false,
    Sets = new[]
    {
        "string",
    },
    Values = "string",
    Version = "string",
    Wait = false,
});
Copy
example, err := cilium.NewInstall(ctx, "installResource", &cilium.InstallArgs{
	DataPath:   pulumi.String("string"),
	Repository: pulumi.String("string"),
	Reset:      pulumi.Bool(false),
	Reuse:      pulumi.Bool(false),
	Sets: pulumi.StringArray{
		pulumi.String("string"),
	},
	Values:  pulumi.String("string"),
	Version: pulumi.String("string"),
	Wait:    pulumi.Bool(false),
})
Copy
var installResource = new Install("installResource", InstallArgs.builder()
    .dataPath("string")
    .repository("string")
    .reset(false)
    .reuse(false)
    .sets("string")
    .values("string")
    .version("string")
    .wait(false)
    .build());
Copy
install_resource = cilium.Install("installResource",
    data_path="string",
    repository="string",
    reset=False,
    reuse=False,
    sets=["string"],
    values="string",
    version="string",
    wait=False)
Copy
const installResource = new cilium.Install("installResource", {
    dataPath: "string",
    repository: "string",
    reset: false,
    reuse: false,
    sets: ["string"],
    values: "string",
    version: "string",
    wait: false,
});
Copy
type: cilium:Install
properties:
    dataPath: string
    repository: string
    reset: false
    reuse: false
    sets:
        - string
    values: string
    version: string
    wait: false
Copy

Install Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Install resource accepts the following input properties:

DataPath string
Datapath mode to use { tunnel | native | aws-eni | gke | azure | aks-byocni } (Default: autodetected).
Repository string
Helm chart repository to download Cilium charts from (Default: https://helm.cilium.io).
Reset bool
When upgrading, reset the helm values to the ones built into the chart (Default: false).
Reuse bool
When upgrading, reuse the helm values from the latest release unless any overrides from are set from other flags. This option takes precedence over HelmResetValues (Default: true).
Sets List<string>
Set helm values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2 (Default: []).
Values string
values in raw yaml to pass to helm. (Default: empty).
Version string
Version of Cilium (Default: v1.14.5).
Wait bool
Wait for Cilium status is ok (Default: true).
DataPath string
Datapath mode to use { tunnel | native | aws-eni | gke | azure | aks-byocni } (Default: autodetected).
Repository string
Helm chart repository to download Cilium charts from (Default: https://helm.cilium.io).
Reset bool
When upgrading, reset the helm values to the ones built into the chart (Default: false).
Reuse bool
When upgrading, reuse the helm values from the latest release unless any overrides from are set from other flags. This option takes precedence over HelmResetValues (Default: true).
Sets []string
Set helm values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2 (Default: []).
Values string
values in raw yaml to pass to helm. (Default: empty).
Version string
Version of Cilium (Default: v1.14.5).
Wait bool
Wait for Cilium status is ok (Default: true).
dataPath String
Datapath mode to use { tunnel | native | aws-eni | gke | azure | aks-byocni } (Default: autodetected).
repository String
Helm chart repository to download Cilium charts from (Default: https://helm.cilium.io).
reset Boolean
When upgrading, reset the helm values to the ones built into the chart (Default: false).
reuse Boolean
When upgrading, reuse the helm values from the latest release unless any overrides from are set from other flags. This option takes precedence over HelmResetValues (Default: true).
sets List<String>
Set helm values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2 (Default: []).
values String
values in raw yaml to pass to helm. (Default: empty).
version String
Version of Cilium (Default: v1.14.5).
wait_ Boolean
Wait for Cilium status is ok (Default: true).
dataPath string
Datapath mode to use { tunnel | native | aws-eni | gke | azure | aks-byocni } (Default: autodetected).
repository string
Helm chart repository to download Cilium charts from (Default: https://helm.cilium.io).
reset boolean
When upgrading, reset the helm values to the ones built into the chart (Default: false).
reuse boolean
When upgrading, reuse the helm values from the latest release unless any overrides from are set from other flags. This option takes precedence over HelmResetValues (Default: true).
sets string[]
Set helm values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2 (Default: []).
values string
values in raw yaml to pass to helm. (Default: empty).
version string
Version of Cilium (Default: v1.14.5).
wait boolean
Wait for Cilium status is ok (Default: true).
data_path str
Datapath mode to use { tunnel | native | aws-eni | gke | azure | aks-byocni } (Default: autodetected).
repository str
Helm chart repository to download Cilium charts from (Default: https://helm.cilium.io).
reset bool
When upgrading, reset the helm values to the ones built into the chart (Default: false).
reuse bool
When upgrading, reuse the helm values from the latest release unless any overrides from are set from other flags. This option takes precedence over HelmResetValues (Default: true).
sets Sequence[str]
Set helm values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2 (Default: []).
values str
values in raw yaml to pass to helm. (Default: empty).
version str
Version of Cilium (Default: v1.14.5).
wait bool
Wait for Cilium status is ok (Default: true).
dataPath String
Datapath mode to use { tunnel | native | aws-eni | gke | azure | aks-byocni } (Default: autodetected).
repository String
Helm chart repository to download Cilium charts from (Default: https://helm.cilium.io).
reset Boolean
When upgrading, reset the helm values to the ones built into the chart (Default: false).
reuse Boolean
When upgrading, reuse the helm values from the latest release unless any overrides from are set from other flags. This option takes precedence over HelmResetValues (Default: true).
sets List<String>
Set helm values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2 (Default: []).
values String
values in raw yaml to pass to helm. (Default: empty).
version String
Version of Cilium (Default: v1.14.5).
wait Boolean
Wait for Cilium status is ok (Default: true).

Outputs

All input properties are implicitly available as output properties. Additionally, the Install resource produces the following output properties:

Ca Littlejo.Cilium.Outputs.InstallCa
Cilium certificates value, Format: {crt: "b64...", key: "b64.."} (Equivalent to kubectl get secret cilium-ca -n kube-system -o yaml)
HelmValues string
Helm values (helm get values -n kube-system cilium)
Id string
The provider-assigned unique ID for this managed resource.
Ca InstallCa
Cilium certificates value, Format: {crt: "b64...", key: "b64.."} (Equivalent to kubectl get secret cilium-ca -n kube-system -o yaml)
HelmValues string
Helm values (helm get values -n kube-system cilium)
Id string
The provider-assigned unique ID for this managed resource.
ca InstallCa
Cilium certificates value, Format: {crt: "b64...", key: "b64.."} (Equivalent to kubectl get secret cilium-ca -n kube-system -o yaml)
helmValues String
Helm values (helm get values -n kube-system cilium)
id String
The provider-assigned unique ID for this managed resource.
ca InstallCa
Cilium certificates value, Format: {crt: "b64...", key: "b64.."} (Equivalent to kubectl get secret cilium-ca -n kube-system -o yaml)
helmValues string
Helm values (helm get values -n kube-system cilium)
id string
The provider-assigned unique ID for this managed resource.
ca InstallCa
Cilium certificates value, Format: {crt: "b64...", key: "b64.."} (Equivalent to kubectl get secret cilium-ca -n kube-system -o yaml)
helm_values str
Helm values (helm get values -n kube-system cilium)
id str
The provider-assigned unique ID for this managed resource.
ca Property Map
Cilium certificates value, Format: {crt: "b64...", key: "b64.."} (Equivalent to kubectl get secret cilium-ca -n kube-system -o yaml)
helmValues String
Helm values (helm get values -n kube-system cilium)
id String
The provider-assigned unique ID for this managed resource.

Look up Existing Install Resource

Get an existing Install resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: InstallState, opts?: CustomResourceOptions): Install
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        ca: Optional[InstallCaArgs] = None,
        data_path: Optional[str] = None,
        helm_values: Optional[str] = None,
        repository: Optional[str] = None,
        reset: Optional[bool] = None,
        reuse: Optional[bool] = None,
        sets: Optional[Sequence[str]] = None,
        values: Optional[str] = None,
        version: Optional[str] = None,
        wait: Optional[bool] = None) -> Install
func GetInstall(ctx *Context, name string, id IDInput, state *InstallState, opts ...ResourceOption) (*Install, error)
public static Install Get(string name, Input<string> id, InstallState? state, CustomResourceOptions? opts = null)
public static Install get(String name, Output<String> id, InstallState state, CustomResourceOptions options)
resources:  _:    type: cilium:Install    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Ca Littlejo.Cilium.Inputs.InstallCa
Cilium certificates value, Format: {crt: "b64...", key: "b64.."} (Equivalent to kubectl get secret cilium-ca -n kube-system -o yaml)
DataPath string
Datapath mode to use { tunnel | native | aws-eni | gke | azure | aks-byocni } (Default: autodetected).
HelmValues string
Helm values (helm get values -n kube-system cilium)
Repository string
Helm chart repository to download Cilium charts from (Default: https://helm.cilium.io).
Reset bool
When upgrading, reset the helm values to the ones built into the chart (Default: false).
Reuse bool
When upgrading, reuse the helm values from the latest release unless any overrides from are set from other flags. This option takes precedence over HelmResetValues (Default: true).
Sets List<string>
Set helm values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2 (Default: []).
Values string
values in raw yaml to pass to helm. (Default: empty).
Version string
Version of Cilium (Default: v1.14.5).
Wait bool
Wait for Cilium status is ok (Default: true).
Ca InstallCaArgs
Cilium certificates value, Format: {crt: "b64...", key: "b64.."} (Equivalent to kubectl get secret cilium-ca -n kube-system -o yaml)
DataPath string
Datapath mode to use { tunnel | native | aws-eni | gke | azure | aks-byocni } (Default: autodetected).
HelmValues string
Helm values (helm get values -n kube-system cilium)
Repository string
Helm chart repository to download Cilium charts from (Default: https://helm.cilium.io).
Reset bool
When upgrading, reset the helm values to the ones built into the chart (Default: false).
Reuse bool
When upgrading, reuse the helm values from the latest release unless any overrides from are set from other flags. This option takes precedence over HelmResetValues (Default: true).
Sets []string
Set helm values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2 (Default: []).
Values string
values in raw yaml to pass to helm. (Default: empty).
Version string
Version of Cilium (Default: v1.14.5).
Wait bool
Wait for Cilium status is ok (Default: true).
ca InstallCa
Cilium certificates value, Format: {crt: "b64...", key: "b64.."} (Equivalent to kubectl get secret cilium-ca -n kube-system -o yaml)
dataPath String
Datapath mode to use { tunnel | native | aws-eni | gke | azure | aks-byocni } (Default: autodetected).
helmValues String
Helm values (helm get values -n kube-system cilium)
repository String
Helm chart repository to download Cilium charts from (Default: https://helm.cilium.io).
reset Boolean
When upgrading, reset the helm values to the ones built into the chart (Default: false).
reuse Boolean
When upgrading, reuse the helm values from the latest release unless any overrides from are set from other flags. This option takes precedence over HelmResetValues (Default: true).
sets List<String>
Set helm values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2 (Default: []).
values String
values in raw yaml to pass to helm. (Default: empty).
version String
Version of Cilium (Default: v1.14.5).
wait_ Boolean
Wait for Cilium status is ok (Default: true).
ca InstallCa
Cilium certificates value, Format: {crt: "b64...", key: "b64.."} (Equivalent to kubectl get secret cilium-ca -n kube-system -o yaml)
dataPath string
Datapath mode to use { tunnel | native | aws-eni | gke | azure | aks-byocni } (Default: autodetected).
helmValues string
Helm values (helm get values -n kube-system cilium)
repository string
Helm chart repository to download Cilium charts from (Default: https://helm.cilium.io).
reset boolean
When upgrading, reset the helm values to the ones built into the chart (Default: false).
reuse boolean
When upgrading, reuse the helm values from the latest release unless any overrides from are set from other flags. This option takes precedence over HelmResetValues (Default: true).
sets string[]
Set helm values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2 (Default: []).
values string
values in raw yaml to pass to helm. (Default: empty).
version string
Version of Cilium (Default: v1.14.5).
wait boolean
Wait for Cilium status is ok (Default: true).
ca InstallCaArgs
Cilium certificates value, Format: {crt: "b64...", key: "b64.."} (Equivalent to kubectl get secret cilium-ca -n kube-system -o yaml)
data_path str
Datapath mode to use { tunnel | native | aws-eni | gke | azure | aks-byocni } (Default: autodetected).
helm_values str
Helm values (helm get values -n kube-system cilium)
repository str
Helm chart repository to download Cilium charts from (Default: https://helm.cilium.io).
reset bool
When upgrading, reset the helm values to the ones built into the chart (Default: false).
reuse bool
When upgrading, reuse the helm values from the latest release unless any overrides from are set from other flags. This option takes precedence over HelmResetValues (Default: true).
sets Sequence[str]
Set helm values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2 (Default: []).
values str
values in raw yaml to pass to helm. (Default: empty).
version str
Version of Cilium (Default: v1.14.5).
wait bool
Wait for Cilium status is ok (Default: true).
ca Property Map
Cilium certificates value, Format: {crt: "b64...", key: "b64.."} (Equivalent to kubectl get secret cilium-ca -n kube-system -o yaml)
dataPath String
Datapath mode to use { tunnel | native | aws-eni | gke | azure | aks-byocni } (Default: autodetected).
helmValues String
Helm values (helm get values -n kube-system cilium)
repository String
Helm chart repository to download Cilium charts from (Default: https://helm.cilium.io).
reset Boolean
When upgrading, reset the helm values to the ones built into the chart (Default: false).
reuse Boolean
When upgrading, reuse the helm values from the latest release unless any overrides from are set from other flags. This option takes precedence over HelmResetValues (Default: true).
sets List<String>
Set helm values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2 (Default: []).
values String
values in raw yaml to pass to helm. (Default: empty).
version String
Version of Cilium (Default: v1.14.5).
wait Boolean
Wait for Cilium status is ok (Default: true).

Supporting Types

InstallCa
, InstallCaArgs

Crt This property is required. string
Key This property is required. string
Crt This property is required. string
Key This property is required. string
crt This property is required. String
key This property is required. String
crt This property is required. string
key This property is required. string
crt This property is required. str
key This property is required. str
crt This property is required. String
key This property is required. String

Package Details

Repository
cilium littlejo/pulumi-cilium
License
Apache-2.0
Notes
This Pulumi package is based on the cilium Terraform Provider.