Interface HelmRegistry

  • All Implemented Interfaces:
    io.github.build.extensions.oss.gradle.plugins.helm.dsl.credentials.CredentialsContainer , org.gradle.api.Named

    
    public interface HelmRegistry
     implements Named, CredentialsContainer
                        

    Represents an OCI registry that charts are pulled from, and which needs a helm registry login first.

    Unlike a HelmRepository, a registry is not registered with Helm by a task of its own. Instead, the tasks that update or build chart dependencies log in to it right before they call Helm, and only if a chart dependency is pulled from it (a repository: oci://<host>/... entry). An up-to-date or skipped task therefore does not log in at all.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Field Summary

      Fields 
      Modifier and Type Field Description
    • Constructor Summary

      Constructors 
      Constructor Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      abstract Property<String> getHost() The registry host, optionally with a port, e.g.
      abstract RegularFileProperty getCaFile() An optional path to a CA bundle used to verify certificates of HTTPS-enabled registries.
      • Methods inherited from class io.github.build.extensions.oss.gradle.plugins.helm.dsl.credentials.CredentialsContainer

        credentials, credentials, getConfiguredCredentials, getCredentials, getCredentials
      • Methods inherited from class org.gradle.api.Named

        getName
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

    • Method Detail

      • getHost

         abstract Property<String> getHost()

        The registry host, optionally with a port, e.g. registry.example.com or registry.example.com:5000.

        This is what helm registry login expects: no scheme and no path.

      • getCaFile

         abstract RegularFileProperty getCaFile()

        An optional path to a CA bundle used to verify certificates of HTTPS-enabled registries.