ingress

Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend. An Ingress can be configured to give services externally-reachable urls, load balance traffic, terminate SSL, offer name based virtual hosting etc. DEPRECATED - This group version of Ingress is deprecated by networking.k8s.io/v1beta1 Ingress. See the release notes for more information.

Constuctors

Mixins
  • metadata

    Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata


    Functions
    • mixinInstance

      mixinInstance(metadata)
      


    • withAnnotations

      withAnnotations(annotations)
      

      Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations


    • withAnnotationsMixin

      withAnnotationsMixin(annotations)
      

      Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations


    • withClusterName

      withClusterName(clusterName)
      

      The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.


    • withFinalizers

      withFinalizers(finalizers)
      

      Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.


    • withFinalizersMixin

      withFinalizersMixin(finalizers)
      

      Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.


    • withGenerateName

      withGenerateName(generateName)
      

      GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

      If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

      Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency


    • withLabels

      withLabels(labels)
      

      Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels


    • withLabelsMixin

      withLabelsMixin(labels)
      

      Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels


    • withManagedFields

      withManagedFields(managedFields)
      

      ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn’t need to set or understand this field. A workflow can be the user’s name, a controller’s name, or the name of a specific apply path like “ci-cd”. The set of fields is always in the version that the workflow used when modifying the object.

      This field is alpha and can be changed or removed without notice.

      withManagedFields takes an array of type managedFieldsType. You can create an instance of managedFieldsType with hidden.meta.v1.managedFieldsEntry.new().

      see hidden.meta.v1.managedFieldsEntry


    • withManagedFieldsMixin

      withManagedFieldsMixin(managedFields)
      

      ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn’t need to set or understand this field. A workflow can be the user’s name, a controller’s name, or the name of a specific apply path like “ci-cd”. The set of fields is always in the version that the workflow used when modifying the object.

      This field is alpha and can be changed or removed without notice.

      withManagedFieldsMixin takes an array of type managedFieldsType. You can create an instance of managedFieldsType with hidden.meta.v1.managedFieldsEntry.new().

      see hidden.meta.v1.managedFieldsEntry


    • withName

      withName(name)
      

      Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names


    • withNamespace

      withNamespace(namespace)
      

      Namespace defines the space within each name must be unique. An empty namespace is equivalent to the “default” namespace, but “default” is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

      Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces


    • withOwnerReferences

      withOwnerReferences(ownerReferences)
      

      List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

      withOwnerReferences takes an array of type ownerReferencesType. You can create an instance of ownerReferencesType with hidden.meta.v1.ownerReference.new().

      see hidden.meta.v1.ownerReference


    • withOwnerReferencesMixin

      withOwnerReferencesMixin(ownerReferences)
      

      List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

      withOwnerReferencesMixin takes an array of type ownerReferencesType. You can create an instance of ownerReferencesType with hidden.meta.v1.ownerReference.new().

      see hidden.meta.v1.ownerReference


    Mixins
    • initializers

      An initializer is a controller which enforces some system invariant at object creation time. This field is a list of initializers that have not yet acted on this object. If nil or empty, this object has been completely initialized. Otherwise, the object is considered uninitialized and is hidden (in list/watch and get calls) from clients that haven't explicitly asked to observe uninitialized objects.

      When an object is created, the system will populate this list with the current set of initializers. Only privileged users may set or modify this list. Once it is empty, it may not be modified further by any user.

      DEPRECATED - initializers are an alpha field and will be removed in v1.15.


      Functions
      • mixinInstance

        mixinInstance(initializers)
        


      • withPending

        withPending(pending)
        

        Pending is a list of initializers that must execute in order before this object is visible. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.

        withPending takes an array of type pendingType. You can create an instance of pendingType with hidden.meta.v1.initializer.new().

        see hidden.meta.v1.initializer


      • withPendingMixin

        withPendingMixin(pending)
        

        Pending is a list of initializers that must execute in order before this object is visible. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.

        withPendingMixin takes an array of type pendingType. You can create an instance of pendingType with hidden.meta.v1.initializer.new().

        see hidden.meta.v1.initializer


  • spec

    Spec is the desired state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status


    Functions
    • mixinInstance

      mixinInstance(spec)
      


    • withRules

      withRules(rules)
      

      A list of host rules used to configure the Ingress. If unspecified, or no rule matches, all traffic is sent to the default backend.

      withRules takes an array of type rulesType. You can create an instance of rulesType with hidden.extensions.v1beta1.ingressRule.new().

      see hidden.extensions.v1beta1.ingressRule


    • withRulesMixin

      withRulesMixin(rules)
      

      A list of host rules used to configure the Ingress. If unspecified, or no rule matches, all traffic is sent to the default backend.

      withRulesMixin takes an array of type rulesType. You can create an instance of rulesType with hidden.extensions.v1beta1.ingressRule.new().

      see hidden.extensions.v1beta1.ingressRule


    • withTls

      withTls(tls)
      

      TLS configuration. Currently the Ingress only supports a single TLS port, 443. If multiple members of this list specify different hosts, they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension, if the ingress controller fulfilling the ingress supports SNI.

      withTls takes an array of type tlsType. You can create an instance of tlsType with hidden.extensions.v1beta1.ingressTls.new().

      see hidden.extensions.v1beta1.ingressTls


    • withTlsMixin

      withTlsMixin(tls)
      

      TLS configuration. Currently the Ingress only supports a single TLS port, 443. If multiple members of this list specify different hosts, they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension, if the ingress controller fulfilling the ingress supports SNI.

      withTlsMixin takes an array of type tlsType. You can create an instance of tlsType with hidden.extensions.v1beta1.ingressTls.new().

      see hidden.extensions.v1beta1.ingressTls


    Mixins
    • backend

      A default backend capable of servicing requests that don't match any rule. At least one of 'backend' or 'rules' must be specified. This field is optional to allow the loadbalancer controller or defaulting logic to specify a global default.


      Functions