Skip to content

Latest commit

 

History

History
145 lines (110 loc) · 5.47 KB

README.md

File metadata and controls

145 lines (110 loc) · 5.47 KB

RemoteResource

Build Status Greenkeeper badge GitHub

RemoteResource is the foundation for implementing continuous deployment with kapitan. It retrieves and applies the configuration for all resources.

Install

kubectl apply -f "https://github.com/razee-io/RemoteResource/releases/latest/download/resource.yaml"

Resource Definition

Sample

apiVersion: "kapitan.razee.io/v1alpha1"
kind: RemoteResource
metadata:
  name: <remote_resource_name>
  namespace: <namespace>
spec:
  requests:
    - options:
        url: https://<source_repo_url>/<file_name1>
        headers:
          <header_key1>: <header_value1>
          <header_key2>: <header_value2>
    - optional: true
      options:
        url: http://<source_repo_url>/<file_name2>

Required Fields

  • .spec.requests

Features

Requests

Options

.spec.requests.options

All options defined in an options object will be passed as is to the http request. This means you can specify things like headers for authentication in this section. See RemoteResourceS3 for authenticating with an S3 object store.

  • Schema:
    • type: object
    • required: [url || uri]
    • optional: [any other other options to be passed along with the request]

Optional

.spec.requests.optional

  • DEFAULT: false

    • if download or applying child resource fails, RemoteResource will stop execution and report error to .status.

  • true

    • if download or applying child resource fails, RemoteResource will continue processing the rest of the defined requests, and will report a warning to .status.

  • Schema:

    • type: boolean

Managed Resource Labels

Reconcile

Child resource: .metadata.labels[kapitan.razee.io/Reconcile]

  • DEFAULT: true
    • A kapitan resource (parent) will clean up a resources it applies (child) when either the child is no longer in the parent resource definition or the parent is deleted.
  • false
    • This behavior can be overridden when a child's resource definition has the label kapitan.razee.io/Reconcile=false.

Resource Update Mode

Child resource: .metadata.labels[kapitan.razee.io/mode]

Kapitan resources default to merge patching children. This behavior can be overridden when a child's resource definition has the label kapitan.razee.io/mode=<mode>

Mode options:

  • DEFAULT: MergePatch
    • A simple merge, that will merge objects and replace arrays. Items previously defined, then removed from the definition, will be removed from the live resource.
    • "As defined in RFC7386, a Merge Patch is essentially a partial representation of the resource. The submitted JSON is "merged" with the current resource to create a new one, then the new one is saved. For more details on how to use Merge Patch, see the RFC." Reference
  • StrategicMergePatch
    • A more complicated merge, the kubernetes apiServer has defined keys to be able to intelligently merge arrays it knows about.
    • "Strategic Merge Patch is a custom implementation of Merge Patch. For a detailed explanation of how it works and why it needed to be introduced, see StrategicMergePatch." Reference
    • Kubectl Apply Semantics
  • EnsureExists
    • Will ensure the resource is created and is replaced if deleted. Will not enforce a definition.

Debug Individual Resource

.spec.resources.metadata.labels[kapitan.razee.io/debug]

Treats the live resource as EnsureExist. If any Kapitan component is enforcing the resource, and the label kapitan.razee.io/debug: true exists on the live resource, it will treat the resource as ensure exist and not override any changes. This is useful for when you need to debug a live resource and dont want Kapitan overriding your changes. Note: this will only work when you add it to live resources. If you want to have the EnsureExist behavior, see Resource Update Mode.

  • ie: kubectl label rr <your-rr> kapitan.razee.io/debug=true

Lock Cluster Updates

Prevents the controller from updating resources on the cluster. If this is the first time creating the kapitan-config ConfigMap, you must delete the running controller pods so the deployment can mount the ConfigMap as a volume. If the kapitan-config ConfigMap already exists, just add the pair lock-cluster: true.

  1. export CONTROLLER_NAME=remoteresource-controller && export CONTROLLER_NAMESPACE=razee
  2. kubectl create cm kapitan-config -n $CONTROLLER_NAMESPACE --from-literal=lock-cluster=true
  3. kubectl delete pods -n $CONTROLLER_NAMESPACE $(kubectl get pods -n $CONTROLLER_NAMESPACE | grep $CONTROLLER_NAME | awk '{print $1}' | paste -s -d ',' -)