getporter / kubernetes-mixin

A Kubernetes mixin for Porter
https://getporter.org/mixins/kubernetes
Apache License 2.0
6 stars 9 forks source link
kubectl kubernetes mixin porter

kubernetes Mixin for Porter

Build Status

This is a kubernetes mixin for Porter. It executes the appropriate helm command based on which action it is included within: install, upgrade, or delete.

Install or Upgrade

porter mixin install kubernetes

Install or Upgrade canary version

porter mixin install kubernetes --version canary --url https://cdn.porter.sh/mixins/kubernetes

Install or Upgrade from feed-url

porter mixin install kubernetes --feed-url https://cdn.porter.sh/mixins/atom.xml

Manually Install or Upgrade with a specific version from github

porter mixin install kubernetes --version $VERSION --url https://github.com/getporter/kubernetes-mixin/releases/download

Mixin Configuration

Kubernetes client version

You can use the clientVersion field to specify the kubectl CLI version.

- kubernetes:
    clientVersion: v1.20.13 # Replace this value with the latest patched version of kubectl

Mixin Actions Syntax

Install Action

install:
  - kubernetes:
      description: "Install Hello World App"
      manifests:
        - /cnab/app/manifests/hello
      wait: true

Upgrade Action

upgrade:
  - kubernetes:
      description: "Upgrade Hello World App"
      manifests:
        - /cnab/app/manifests/hello
      wait: true

Uninstall Action

uninstall:
  - kubernetes:
      description: "Uninstall Hello World App"
      manifests:
        - /cnab/app/manifests/hello
      wait: true

\* Uninstall automatically applies the --ignore-not-found flag so that you can safely repeat the uninstall action without errors.

Outputs

The mixin supports extracting resource metadata from Kubernetes as outputs.

outputs:
    - name: NAME
      resourceType: RESOURCE_TYPE
      resourceName: RESOURCE_TYPE_NAME
      namespace: NAMESPACE
      jsonPath: JSON_PATH_DEFINITION