Class Helm


  • public abstract class Helm
    extends Object
    A factory of Helm commands.

    Copyright (c) 2018. All Rights Reserved. Oracle Corporation.
    Oracle is a registered trademark of Oracle Corporation and/or its affiliates.

    Author:
    Jonathan Knight
    • Method Detail

      • create

        public static HelmCreate create​(String name)
        Create a new chart with the given name.
        Parameters:
        name - the name of the chart to create
      • delete

        public static HelmDelete delete​(String name)
        Given a release name, delete the release from Kubernetes.
        Parameters:
        name - the release to delete
      • dependencyBuild

        public static HelmDependencyBuild dependencyBuild​(String chart)
        Manage a chart's dependencies - rebuild the charts/ directory based on the requirements.lock file.
        Parameters:
        chart - the chart name
      • dependencyList

        public static HelmDependencyList dependencyList​(String chart)
        Manage a chart's dependencies - list the dependencies for the given chart.
        Parameters:
        chart - the chart name
      • dependencyUpdate

        public static HelmDependencyUpdate dependencyUpdate​(String chart)
        Manage a chart's dependencies - update charts/ based on the contents of requirements.yaml.
        Parameters:
        chart - the chart name
      • fetch

        public static HelmFetch fetch​(String... charts)
        Download a chart from a repository and (optionally) unpack it in local directory.
        Parameters:
        charts - the charts to download
      • get

        public static HelmGet get​(String release)
        Download a named release.
        Parameters:
        release - the name of the release
      • getHooks

        public static HelmGetHooks getHooks​(String release)
        Download all hooks for a named release.
        Parameters:
        release - the name of the release
      • getManifest

        public static HelmGetManifest getManifest​(String release)
        Download the manifest for a named release.
        Parameters:
        release - the name of the release
      • getValues

        public static HelmGetValues getValues​(String release)
        Download the values file for a named release.
        Parameters:
        release - the name of the release
      • history

        public static HelmHistory history​(String release)
        Fetch a release history.
        Parameters:
        release - the name of the release
      • init

        public static HelmInit init()
        Initialize Helm on both client and server.
      • inspect

        public static HelmInspect inspect​(String chart)
        Create a Helm inspect command.
        Parameters:
        chart - the name of the chart
      • inspectChart

        public static HelmInspect inspectChart​(String chart)
        Create a Helm inspect chart command.
        Parameters:
        chart - the name of the chart
      • inspectChart

        public static HelmInspect inspectChart​(File chart)
        Create a Helm inspect chart command.
        Parameters:
        chart - the name of the chart
      • inspectChart

        public static HelmInspect inspectChart​(URL chart)
        Create a Helm inspect chart command.
        Parameters:
        chart - the name of the chart
      • inspectValues

        public static HelmInspect inspectValues​(String chart)
        Create a Helm inspect values command.
        Parameters:
        chart - the name of the chart
      • install

        public static HelmInstall install​(String chart)
        Install a chart archive.
        Parameters:
        chart - the location of the chart to install
      • install

        public static HelmInstall install​(File chart)
        Install a chart archive.
        Parameters:
        chart - the location of the chart to install
      • install

        public static HelmInstall install​(File parentDir,
                                          String chartName)
        Install a chart archive.
        Parameters:
        parentDir - the directory containing the charts
        chartName - the name of the chart to install
      • lint

        public static HelmLint lint​(String chart)
        Examines a chart for possible issues.
        Parameters:
        chart - the location of the chart to install
      • lint

        public static HelmLint lint​(File chart)
        Examines a chart for possible issues.
        Parameters:
        chart - the location of the chart to install
      • lint

        public static HelmLint lint​(File parentDir,
                                    String chartName)
        Examines a chart for possible issues.
        Parameters:
        parentDir - the directory containing the charts
        chartName - the name of the chart to install
      • list

        public static HelmList list()
        List releases.
      • list

        public static HelmList list​(String filter)
        List releases.
        Parameters:
        filter - the Helm list command's filter argument
      • rollback

        public static HelmRollback rollback​(String release,
                                            String revision)
        Roll back a release to a previous revision.
        Parameters:
        release - the name of the release
        revision - the revision to rollback to
      • status

        public static HelmStatus status​(String release)
        Displays the status of the named release.
        Parameters:
        release - the name of the release
      • test

        public static HelmTest test​(String release)
        Test a release.
        Parameters:
        release - the name of the release
      • upgrade

        public static HelmUpgrade upgrade​(String release,
                                          String chart)
        Upgrade a release.
        Parameters:
        release - the name of the release to be upgraded
        chart - the name of the chart to use to upgrade the release
      • upgrade

        public static HelmUpgrade upgrade​(String release,
                                          File chart)
        Upgrade a release.
        Parameters:
        release - the name of the release to be upgraded
        chart - the name of the chart to use to upgrade the release