diff --git a/.circleci/config.yml b/.circleci/config.yml index 4ea0eb2bf..e9932fc54 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -45,6 +45,7 @@ jobs: helm init --service-account default --wait - run: .circleci/helm-test.sh oathkeeper - run: .circleci/helm-test.sh hydra + # - run: .circleci/helm-test.sh maester release: docker: diff --git a/docs/helm/README.md b/docs/helm/README.md index 6356f986d..239653e4d 100644 --- a/docs/helm/README.md +++ b/docs/helm/README.md @@ -11,3 +11,4 @@ Documentation on each individual chart can be found for - [ORY Hydra Helm Chart](./hydra) - [ORY Oathkeeper Helm Chart](./oathkeeper) +- [ORY Maester Helm Chart](./maester) diff --git a/docs/helm/maester.md b/docs/helm/maester.md new file mode 100644 index 000000000..5a4c976fc --- /dev/null +++ b/docs/helm/maester.md @@ -0,0 +1,43 @@ +# ORY Maester Helm Chart + +ORY Maester is a Kubernetes controller that watches for instances of `rules.oathkeeper.ory.sh/v1alpha1` custom resource (CR) and creates or updates the Oathkeeper ConfigMap with Access Rules found in the CRs. The controller passes the Access Rules as an array in a format recognized by the Oathkeeper. +By mounting the ConfigMap to the Oathkeeper Pod, you can manage the list of Oathkeeper Rules through `rules.oathkeeper.ory.sh/v1alpha1` CR instances. + + +## Installation + +To install ORY Maester with Helm, run: + +```bash +$ helm install ory/maester +``` + +## Configuration + +These are the most important configuration values used to control ConfigMap creation: + +- `configMapName` defines the name of the ConfigMap used to store the list of Access Rules. Defaults to `oathkeeper-rules` +- `rulesConfigmapNamespace` defines the Namespace in which the ConfigMap is stored. Defaults to the same Namespace as the ORY Maester Helm release. +- `rulesFileName` defines the name of the single root-level ConfigMap key used to store the entire array of Access Rules. When the ConfigMap is mounted in the Oathkeeper Pod, this becomes also the filename of the "rules file" to the Oathkeeper process. Defaults to `access-rules.json`. + +You can set the values in `values.yaml` file or using `--set` syntax of Helm during chart installation. + +## Custom Resource Syntax + +ORY Maester introduces its own Custom Resource Definition (CRD) of type `rules.oathkeeper.ory.sh/v1alpha1`. +Each CR instance defines the rules for a single service. + +The syntax of the CR **Spec** field reflects the Oathkeeper [Access Rule syntax](https://www.ory.sh/docs/next/oathkeeper/api-access-rules), with the following differences: +- The `id` field is auto-generated. +- The `upstream.preserveHost` property is camel cased. +- The `upstream.stripPath` property is camel cased. + +The JSON schema specified in the CRD provides definitions for all available attributes. +All handlers such as authenticators, the authorizer, and the mutator are passed verbatim without any changes to the target Access Rules list. + +The controller provides the following defaults for each Access Rule it creates: +- If `authenticators` are not defined, it defaults to a single `unauthorized` handler. +- If `authorizer` is not defined, it defaults to a `deny` handler. +- If `mutator` is not defined, it defaults to a `noop` handler. + +These defaults implement a "disabled by default" policy for increased security. diff --git a/helm/charts/maester/.helmignore b/helm/charts/maester/.helmignore new file mode 100644 index 000000000..50af03172 --- /dev/null +++ b/helm/charts/maester/.helmignore @@ -0,0 +1,22 @@ +# Patterns to ignore when building packages. +# This supports shell glob matching, relative path matching, and +# negation (prefixed with !). Only one pattern per line. +.DS_Store +# Common VCS dirs +.git/ +.gitignore +.bzr/ +.bzrignore +.hg/ +.hgignore +.svn/ +# Common backup files +*.swp +*.bak +*.tmp +*~ +# Various IDEs +.project +.idea/ +*.tmproj +.vscode/ diff --git a/helm/charts/maester/Chart.yaml b/helm/charts/maester/Chart.yaml new file mode 100644 index 000000000..cacf17053 --- /dev/null +++ b/helm/charts/maester/Chart.yaml @@ -0,0 +1,22 @@ +apiVersion: v1 +appVersion: "v0.0.1" +description: A Helm chart for deployoing ORY Oathkeeper Rule Controller in Kubernetes +name: maester +version: 0.0.1 +keywords: + - zero-trust + - beyond-corp + - access-control + - reverse-proxy + - nginx + - envoy + - ambassador + - auth-filter +home: https://www.ory.sh/ +sources: + - https://github.com/ory/oathkeeper + - https://github.com/ory/k8s +maintainers: # (optional) + - name: ORY Team + email: hi@ory.sh + url: https://www.ory.sh/ diff --git a/helm/charts/maester/templates/_helpers.tpl b/helm/charts/maester/templates/_helpers.tpl new file mode 100644 index 000000000..8b7481585 --- /dev/null +++ b/helm/charts/maester/templates/_helpers.tpl @@ -0,0 +1,45 @@ +{{/* vim: set filetype=mustache: */}} +{{/* +Expand the name of the chart. +*/}} +{{- define "maester.name" -}} +{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" -}} +{{- end -}} + +{{/* +Create a default fully qualified app name. +We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec). +If release name contains chart name it will be used as a full name. +*/}} +{{- define "maester.fullname" -}} +{{- if .Values.fullnameOverride -}} +{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" -}} +{{- else -}} +{{- $name := default .Chart.Name .Values.nameOverride -}} +{{- if contains $name .Release.Name -}} +{{- .Release.Name | trunc 63 | trimSuffix "-" -}} +{{- else -}} +{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" -}} +{{- end -}} +{{- end -}} +{{- end -}} + +{{/* +Create chart name and version as used by the chart label. +*/}} +{{- define "maester.chart" -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}} +{{- end -}} + +{{/* +Common labels +*/}} +{{- define "maester.labels" -}} +app.kubernetes.io/name: {{ include "maester.name" . }} +helm.sh/chart: {{ include "maester.chart" . }} +app.kubernetes.io/instance: {{ .Release.Name }} +{{- if .Chart.AppVersion }} +app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} +{{- end }} +app.kubernetes.io/managed-by: {{ .Release.Service }} +{{- end -}} diff --git a/helm/charts/maester/templates/crd.yaml b/helm/charts/maester/templates/crd.yaml new file mode 100644 index 000000000..e05224a5b --- /dev/null +++ b/helm/charts/maester/templates/crd.yaml @@ -0,0 +1,483 @@ +apiVersion: apiextensions.k8s.io/v1beta1 +kind: CustomResourceDefinition +metadata: + name: rules.oathkeeper.ory.sh +spec: + group: oathkeeper.ory.sh + names: + kind: Rule + plural: rules + scope: "" + validation: + openAPIV3Schema: + description: Rule is the Schema for the rules API + properties: + apiVersion: + description: 'APIVersion defines the versioned schema of this representation + of an object. Servers should convert recognized schemas to the latest + internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources' + type: string + kind: + description: 'Kind is a string value representing the REST resource this + object represents. Servers may infer this from the endpoint the client + submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds' + type: string + metadata: + properties: + annotations: + additionalProperties: + type: string + description: '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' + type: object + clusterName: + description: 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. + type: string + creationTimestamp: + description: "CreationTimestamp is a timestamp representing the server + time when this object was created. It is not guaranteed to be set + in happens-before order across separate operations. Clients may not + set this value. It is represented in RFC3339 form and is in UTC. \n + Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata" + format: date-time + type: string + deletionGracePeriodSeconds: + description: Number of seconds allowed for this object to gracefully + terminate before it will be removed from the system. Only set when + deletionTimestamp is also set. May only be shortened. Read-only. + format: int64 + type: integer + deletionTimestamp: + description: "DeletionTimestamp is RFC 3339 date and time at which this + resource will be deleted. This field is set by the server when a graceful + deletion is requested by the user, and is not directly settable by + a client. The resource is expected to be deleted (no longer visible + from resource lists, and not reachable by name) after the time in + this field, once the finalizers list is empty. As long as the finalizers + list contains items, deletion is blocked. Once the deletionTimestamp + is set, this value may not be unset or be set further into the future, + although it may be shortened or the resource may be deleted prior + to this time. For example, a user may request that a pod is deleted + in 30 seconds. The Kubelet will react by sending a graceful termination + signal to the containers in the pod. After that 30 seconds, the Kubelet + will send a hard termination signal (SIGKILL) to the container and + after cleanup, remove the pod from the API. In the presence of network + partitions, this object may still exist after this timestamp, until + an administrator or automated process can determine the resource is + fully terminated. If not set, graceful deletion of the object has + not been requested. \n Populated by the system when a graceful deletion + is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata" + format: date-time + type: string + finalizers: + description: 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. + items: + type: string + type: array + generateName: + description: "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. \n 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). \n Applied only if Name is not specified. + More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency" + type: string + generation: + description: A sequence number representing a specific generation of + the desired state. Populated by the system. Read-only. + format: int64 + type: integer + initializers: + description: "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. \n + 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. \n DEPRECATED - initializers are an alpha field and will + be removed in v1.15." + properties: + pending: + description: 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. + items: + properties: + name: + description: name of the process that is responsible for initializing + this object. + type: string + required: + - name + type: object + type: array + result: + description: If result is set with the Failure field, the object + will be persisted to storage and then deleted, ensuring that other + clients can observe the deletion. + properties: + apiVersion: + description: 'APIVersion defines the versioned schema of this + representation of an object. Servers should convert recognized + schemas to the latest internal value, and may reject unrecognized + values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources' + type: string + code: + description: Suggested HTTP return code for this status, 0 if + not set. + format: int32 + type: integer + details: + description: Extended data associated with the reason. Each + reason may define its own extended details. This field is + optional and the data returned is not guaranteed to conform + to any schema except that defined by the reason type. + properties: + causes: + description: The Causes array includes more details associated + with the StatusReason failure. Not all StatusReasons may + provide detailed causes. + items: + properties: + field: + description: "The field of the resource that has caused + this error, as named by its JSON serialization. + May include dot and postfix notation for nested + attributes. Arrays are zero-indexed. Fields may + appear more than once in an array of causes due + to fields having multiple errors. Optional. \n Examples: + \ \"name\" - the field \"name\" on the current + resource \"items[0].name\" - the field \"name\" + on the first array entry in \"items\"" + type: string + message: + description: A human-readable description of the cause + of the error. This field may be presented as-is + to a reader. + type: string + reason: + description: A machine-readable description of the + cause of the error. If this value is empty there + is no information available. + type: string + type: object + type: array + group: + description: The group attribute of the resource associated + with the status StatusReason. + type: string + kind: + description: 'The kind attribute of the resource associated + with the status StatusReason. On some operations may differ + from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds' + type: string + name: + description: The name attribute of the resource associated + with the status StatusReason (when there is a single name + which can be described). + type: string + retryAfterSeconds: + description: If specified, the time in seconds before the + operation should be retried. Some errors may indicate + the client must take an alternate action - for those errors + this field may indicate how long to wait before taking + the alternate action. + format: int32 + type: integer + uid: + description: 'UID of the resource. (when there is a single + resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids' + type: string + type: object + kind: + description: 'Kind is a string value representing the REST resource + this object represents. Servers may infer this from the endpoint + the client submits requests to. Cannot be updated. In CamelCase. + More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds' + type: string + message: + description: A human-readable description of the status of this + operation. + type: string + metadata: + description: 'Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds' + properties: + continue: + description: continue may be set if the user set a limit + on the number of items returned, and indicates that the + server has more data available. The value is opaque and + may be used to issue another request to the endpoint that + served this list to retrieve the next set of available + objects. Continuing a consistent list may not be possible + if the server configuration has changed or more than a + few minutes have passed. The resourceVersion field returned + when using this continue value will be identical to the + value in the first response, unless you have received + this token from an error message. + type: string + resourceVersion: + description: 'String that identifies the server''s internal + version of this object that can be used by clients to + determine when objects have changed. Value must be treated + as opaque by clients and passed unmodified back to the + server. Populated by the system. Read-only. More info: + https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency' + type: string + selfLink: + description: selfLink is a URL representing this object. + Populated by the system. Read-only. + type: string + type: object + reason: + description: A machine-readable description of why this operation + is in the "Failure" status. If this value is empty there is + no information available. A Reason clarifies an HTTP status + code but does not override it. + type: string + status: + description: 'Status of the operation. One of: "Success" or + "Failure". More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status' + type: string + type: object + required: + - pending + type: object + labels: + additionalProperties: + type: string + description: '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' + type: object + managedFields: + description: "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. \n This field is alpha and can be changed or removed without + notice." + items: + properties: + apiVersion: + description: APIVersion defines the version of this resource that + this field set applies to. The format is "group/version" just + like the top-level APIVersion field. It is necessary to track + the version of a field set because it cannot be automatically + converted. + type: string + fields: + additionalProperties: true + description: Fields identifies a set of fields. + type: object + manager: + description: Manager is an identifier of the workflow managing + these fields. + type: string + operation: + description: Operation is the type of operation which lead to + this ManagedFieldsEntry being created. The only valid values + for this field are 'Apply' and 'Update'. + type: string + time: + description: Time is timestamp of when these fields were set. + It should always be empty if Operation is 'Apply' + format: date-time + type: string + type: object + type: array + name: + description: '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' + type: string + namespace: + description: "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. \n Must be a DNS_LABEL. Cannot be updated. More info: + http://kubernetes.io/docs/user-guide/namespaces" + type: string + ownerReferences: + description: 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. + items: + properties: + apiVersion: + description: API version of the referent. + type: string + blockOwnerDeletion: + description: If true, AND if the owner has the "foregroundDeletion" + finalizer, then the owner cannot be deleted from the key-value + store until this reference is removed. Defaults to false. To + set this field, a user needs "delete" permission of the owner, + otherwise 422 (Unprocessable Entity) will be returned. + type: boolean + controller: + description: If true, this reference points to the managing controller. + type: boolean + kind: + description: 'Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds' + type: string + name: + description: 'Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names' + type: string + uid: + description: 'UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids' + type: string + required: + - apiVersion + - kind + - name + - uid + type: object + type: array + resourceVersion: + description: "An opaque value that represents the internal version of + this object that can be used by clients to determine when objects + have changed. May be used for optimistic concurrency, change detection, + and the watch operation on a resource or set of resources. Clients + must treat these values as opaque and passed unmodified back to the + server. They may only be valid for a particular resource or set of + resources. \n Populated by the system. Read-only. Value must be treated + as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency" + type: string + selfLink: + description: SelfLink is a URL representing this object. Populated by + the system. Read-only. + type: string + uid: + description: "UID is the unique in time and space value for this object. + It is typically generated by the server on successful creation of + a resource and is not allowed to change on PUT operations. \n Populated + by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids" + type: string + type: object + spec: + properties: + authenticators: + items: + properties: + config: + description: Config configures the handler. Configuration keys + vary per handler. + type: object + handler: + description: Name is the name of a handler + type: string + required: + - handler + type: object + type: array + authorizer: + properties: + config: + description: Config configures the handler. Configuration keys vary + per handler. + type: object + handler: + description: Name is the name of a handler + type: string + required: + - handler + type: object + match: + properties: + methods: + description: Methods represent an array of HTTP methods (e.g. GET, + POST, PUT, DELETE, ...) + items: + type: string + type: array + url: + description: URL is the URL that should be matched. It supports + regex templates. + type: string + required: + - url + - methods + type: object + mutator: + properties: + config: + description: Config configures the handler. Configuration keys vary + per handler. + type: object + handler: + description: Name is the name of a handler + type: string + required: + - handler + type: object + upstream: + properties: + preserveHost: + description: PreserveHost includes the host and port of the url + value if set to false. If true, the host and port of the ORY Oathkeeper + Proxy will be used instead. + type: boolean + stripPath: + description: StripPath replaces the provided path prefix when forwarding + the requested URL to the upstream URL. + type: string + url: + description: URL defines the target URL for incoming requests + maxLength: 256 + minLength: 3 + pattern: ^(?:https?:\/\/)?(?:[^@\/\n]+@)?(?:www\.)?([^:\/\n]+) + type: string + required: + - url + type: object + required: + - upstream + - match + type: object + status: + properties: + validation: + properties: + valid: + type: boolean + validationError: + type: string + type: object + type: object + type: object + versions: + - name: v1alpha1 + served: true + storage: true +status: + acceptedNames: + kind: "" + plural: "" + conditions: [] + storedVersions: [] diff --git a/helm/charts/maester/templates/deployment.yaml b/helm/charts/maester/templates/deployment.yaml new file mode 100644 index 000000000..c951bcd0c --- /dev/null +++ b/helm/charts/maester/templates/deployment.yaml @@ -0,0 +1,76 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: {{ include "maester.fullname" . }} + {{- if .Release.Namespace }} + namespace: {{ .Release.Namespace }} + {{- end }} + labels: +{{ include "maester.labels" . | indent 4 }} +spec: + automountServiceAccountToken: false + progressDeadlineSeconds: 600 + replicas: {{ .Values.replicaCount }} + revisionHistoryLimit: 10 + selector: + matchLabels: + control-plane: controller-manager + app.kubernetes.io/name: {{ include "maester.name" . }} + app.kubernetes.io/instance: {{ .Release.Name }} + strategy: + rollingUpdate: + maxSurge: 25% + maxUnavailable: 25% + type: RollingUpdate + template: + metadata: + labels: + control-plane: controller-manager + app.kubernetes.io/name: {{ include "maester.name" . }} + app.kubernetes.io/instance: {{ .Release.Name }} + {{- with .Values.annotations }} + annotations: + {{- toYaml . | nindent 8 }} + {{- end }} + spec: + containers: + - name: {{ .Chart.Name }} + image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}" + imagePullPolicy: {{ .Values.image.pullPolicy }} + command: + - /manager + args: + - --metrics-addr=127.0.0.1:8080 + - --rulesConfigmapName={{ .Values.configMapName }} + {{- if .Values.rulesConfigmapNamespace }} + - --rulesConfigmapNamespace={{ .Values.rulesConfigmapNamespace }} + {{- else }} + - --rulesConfigmapNamespace={{ .Release.Namespace }} + {{- end }} + {{- if .Values.rulesFileName }} + - --rulesFileName={{ .Values.rulesFileName }} + {{- end }} + resources: + {{- toYaml .Values.resources | nindent 12 }} + terminationMessagePath: /dev/termination-log + terminationMessagePolicy: File + serviceAccountName: maester-account + dnsPolicy: ClusterFirst + restartPolicy: Always + schedulerName: default-scheduler + securityContext: {} + terminationGracePeriodSeconds: 10 + resources: + {{- toYaml .Values.resources | nindent 12 }} + {{- with .Values.nodeSelector }} + nodeSelector: + {{- toYaml . | nindent 8 }} + {{- end }} + {{- with .Values.affinity }} + affinity: + {{- toYaml . | nindent 8 }} + {{- end }} + {{- with .Values.tolerations }} + tolerations: + {{- toYaml . | nindent 8 }} + {{- end }} diff --git a/helm/charts/maester/templates/rbac.yaml b/helm/charts/maester/templates/rbac.yaml new file mode 100644 index 000000000..8481d76c0 --- /dev/null +++ b/helm/charts/maester/templates/rbac.yaml @@ -0,0 +1,36 @@ +--- +apiVersion: v1 +kind: ServiceAccount +metadata: + name: maester-account + namespace: {{ .Release.Namespace }} +--- +kind: ClusterRole +apiVersion: rbac.authorization.k8s.io/v1beta1 +metadata: + name: maester-role + # namespace: {{ .Release.Namespace }} +rules: + - apiGroups: ["oathkeeper.ory.sh"] + resources: ["rules"] + verbs: ["*"] + - apiGroups: [""] + resources: ["configmaps"] + verbs: ["get", "list", "watch", "create", "patch", "update"] + # TODO, fix controller call from all namespaces to single namespace + # resourceNames: + # - {{ .Values.configMapName | default "ory-oathkeeper-rules" }} +--- +kind: ClusterRoleBinding +apiVersion: rbac.authorization.k8s.io/v1beta1 +metadata: + name: maester-role-binding + namespace: {{ .Release.Namespace }} +subjects: + - kind: ServiceAccount + name: maester-account # Service account assigned to the controller pod. + namespace: {{ .Release.Namespace }} +roleRef: + apiGroup: rbac.authorization.k8s.io + kind: ClusterRole + name: maester-role diff --git a/helm/charts/maester/values.yaml b/helm/charts/maester/values.yaml new file mode 100644 index 000000000..edd5ae4b5 --- /dev/null +++ b/helm/charts/maester/values.yaml @@ -0,0 +1,39 @@ +replicaCount: 1 + +configMapName: ory-oathkeeper-rules +# rulesConfigmapNamespace: some-namespace +# rulesFileName: access-rules.json + +image: + # ORY Oathkeeper Rule Controller image + repository: oryd/oathkeeper-maester + # ORY Oathkeeper Rule Controller version + tag: "v0.0.1" + # Image pull policy + pullPolicy: IfNotPresent + +resources: {} + # We usually recommend not to specify default resources and to leave this as a conscious + # choice for the user. This also increases chances charts run on environments with little + # resources, such as Minikube. If you do want to specify resources, uncomment the following + # lines, adjust them as necessary, and remove the curly braces after 'resources:'. + # limits: + # cpu: 100m + # memory: 30Mi + # requests: + # cpu: 100m + # memory: 20Mi + +# Node labels for pod assignment. +nodeSelector: {} +# If you do want to specify node labels, uncomment the following +# lines, adjust them as necessary, and remove the curly braces after 'annotations:'. +# foo: bar + +# Configure node tolerations. +tolerations: [] + +# Configure node affinity +affinity: {} + +annotations: {} diff --git a/helm/charts/oathkeeper/templates/configmap.yaml b/helm/charts/oathkeeper/templates/configmap-config-demo.yaml similarity index 79% rename from helm/charts/oathkeeper/templates/configmap.yaml rename to helm/charts/oathkeeper/templates/configmap-config-demo.yaml index 7c7a27537..d53f0d7a3 100644 --- a/helm/charts/oathkeeper/templates/configmap.yaml +++ b/helm/charts/oathkeeper/templates/configmap-config-demo.yaml @@ -1,23 +1,19 @@ +{{ if .Values.demo }} +--- apiVersion: v1 kind: ConfigMap metadata: - name: {{ include "oathkeeper.fullname" . }} + name: {{ include "oathkeeper.fullname" . }}-config-demo {{- if .Release.Namespace }} namespace: {{ .Release.Namespace }} {{- end }} labels: {{ include "oathkeeper.labels" . | indent 4 }} data: -{{- if .Values.oathkeeper.accessRules}} - "access-rules.json": | - {{- .Values.oathkeeper.accessRules | nindent 4 }} -{{- end}} "config.yaml": | -{{- if .Values.demo }} access_rules: repositories: - "https://raw.githubusercontent.com/ory/k8s/master/helm/charts/oathkeeper/demo/access-rules.json" - authenticators: anonymous: enabled: true @@ -29,13 +25,11 @@ data: enabled: true unauthorized: enabled: true - authorizers: allow: enabled: true deny: enabled: true - mutators: cookie: enabled: true @@ -47,7 +41,6 @@ data: jwks_url: https://raw.githubusercontent.com/ory/k8s/master/helm/charts/oathkeeper/demo/mutator.id_token.jwks.json noop: enabled: true - serve: proxy: cors: @@ -55,8 +48,4 @@ data: api: cors: enabled: true -{{- else -}} -{{- with .Values.oathkeeper.config -}} - {{- toYaml . | nindent 4 }} -{{- end -}} -{{- end -}} \ No newline at end of file +{{ end }} \ No newline at end of file diff --git a/helm/charts/oathkeeper/templates/configmap-config.yaml b/helm/charts/oathkeeper/templates/configmap-config.yaml new file mode 100644 index 000000000..d4f478a85 --- /dev/null +++ b/helm/charts/oathkeeper/templates/configmap-config.yaml @@ -0,0 +1,17 @@ +{{ if not .Values.demo }} +--- +apiVersion: v1 +kind: ConfigMap +metadata: + name: {{ include "oathkeeper.fullname" . }}-config + {{- if .Release.Namespace }} + namespace: {{ .Release.Namespace }} + {{- end }} + labels: +{{ include "oathkeeper.labels" . | indent 4 }} +data: + "config.yaml": | +{{- with .Values.oathkeeper.config -}} + {{- toYaml . | nindent 4 }} +{{- end -}} +{{ end }} \ No newline at end of file diff --git a/helm/charts/oathkeeper/templates/configmap-rules.yaml b/helm/charts/oathkeeper/templates/configmap-rules.yaml new file mode 100644 index 000000000..11be8d3e9 --- /dev/null +++ b/helm/charts/oathkeeper/templates/configmap-rules.yaml @@ -0,0 +1,13 @@ +--- +apiVersion: v1 +kind: ConfigMap +metadata: + name: {{ include "oathkeeper.fullname" . }}-rules + {{- if .Release.Namespace }} + namespace: {{ .Release.Namespace }} + {{- end }} + labels: +{{ include "oathkeeper.labels" . | indent 4 }} +data: + "access-rules.json": | + {{ .Values.oathkeeper.accessRules | default "[]" }} diff --git a/helm/charts/oathkeeper/templates/deployment.yaml b/helm/charts/oathkeeper/templates/deployment.yaml index fc787a720..d97f7dd2c 100644 --- a/helm/charts/oathkeeper/templates/deployment.yaml +++ b/helm/charts/oathkeeper/templates/deployment.yaml @@ -1,3 +1,4 @@ +--- apiVersion: apps/v1 kind: Deployment metadata: @@ -18,6 +19,10 @@ spec: labels: app.kubernetes.io/name: {{ include "oathkeeper.name" . }} app.kubernetes.io/instance: {{ .Release.Name }} + {{- with .Values.deployment.annotations }} + annotations: + {{- toYaml . | nindent 8 }} + {{- end }} spec: {{- with .Values.imagePullSecrets }} imagePullSecrets: @@ -26,7 +31,14 @@ spec: volumes: - name: {{ include "oathkeeper.name" . }}-config-volume configMap: - name: {{ include "oathkeeper.fullname" . }} + {{- if .Values.demo }} + name: {{ include "oathkeeper.fullname" . }}-config-demo + {{- else }} + name: {{ include "oathkeeper.fullname" . }}-config + {{- end }} + - name: {{ include "oathkeeper.name" . }}-rules-volume + configMap: + name: {{ include "oathkeeper.fullname" . }}-rules - name: {{ include "oathkeeper.name" . }}-secrets-volume secret: secretName: {{ include "oathkeeper.fullname" . }} @@ -40,14 +52,17 @@ spec: - name: MUTATORS_ID_TOKEN_JWKS_URL value: "file:///etc/secrets/mutator.id_token.jwks.json" {{- end }} - {{- if .Values.oathkeeper.accessRules }} + {{- if not .Values.demo }} - name: ACCESS_RULES_REPOSITORIES - value: "file:///etc/config/access-rules.json" + value: "file:///etc/rules/access-rules.json" {{- end }} volumeMounts: - name: {{ include "oathkeeper.name" . }}-config-volume mountPath: /etc/config readOnly: true + - name: {{ include "oathkeeper.name" . }}-rules-volume + mountPath: /etc/rules + readOnly: true - name: {{ include "oathkeeper.name" . }}-secrets-volume mountPath: /etc/secrets readOnly: true @@ -67,8 +82,8 @@ spec: path: /health/ready port: http-api resources: - {{- toYaml .Values.resources | nindent 12 }} - {{- with .Values.nodeSelector }} + {{- toYaml .Values.deployment.resources | nindent 12 }} + {{- with .Values.deployment.nodeSelector }} nodeSelector: {{- toYaml . | nindent 8 }} {{- end }} @@ -76,7 +91,7 @@ spec: affinity: {{- toYaml . | nindent 8 }} {{- end }} - {{- with .Values.tolerations }} + {{- with .Values.deployment.tolerations }} tolerations: {{- toYaml . | nindent 8 }} {{- end }} diff --git a/helm/charts/oathkeeper/values.yaml b/helm/charts/oathkeeper/values.yaml index cf7c8a3d6..251d1cd88 100644 --- a/helm/charts/oathkeeper/values.yaml +++ b/helm/charts/oathkeeper/values.yaml @@ -88,26 +88,29 @@ oathkeeper: # If set, uses the given access rules. # accessRules: {} -resources: {} -# We usually recommend not to specify default resources and to leave this as a conscious -# choice for the user. This also increases chances charts run on environments with little -# resources, such as Minikube. If you do want to specify resources, uncomment the following -# lines, adjust them as necessary, and remove the curly braces after 'resources:'. -# limits: -# cpu: 100m -# memory: 128Mi -# requests: -# cpu: 100m -# memory: 128Mi +deployment: + resources: {} + # We usually recommend not to specify default resources and to leave this as a conscious + # choice for the user. This also increases chances charts run on environments with little + # resources, such as Minikube. If you do want to specify resources, uncomment the following + # lines, adjust them as necessary, and remove the curly braces after 'resources:'. + # limits: + # cpu: 100m + # memory: 128Mi + # requests: + # cpu: 100m + # memory: 128Mi -# Node labels for pod assignment. -nodeSelector: {} -# If you do want to specify node labels, uncomment the following -# lines, adjust them as necessary, and remove the curly braces after 'annotations:'. -# foo: bar + # Node labels for pod assignment. + nodeSelector: {} + # If you do want to specify node labels, uncomment the following + # lines, adjust them as necessary, and remove the curly braces after 'annotations:'. + # foo: bar -# Configure node tolerations. -tolerations: [] + # Configure node tolerations. + tolerations: [] + # Annotations + annotations: {} # Configure node affinity -affinity: {} +affinity: {} \ No newline at end of file