-
Notifications
You must be signed in to change notification settings - Fork 40
CM-716: Add HTTP01 Challenge Proxy controller #398
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| package v1alpha1 | ||
|
|
||
| import ( | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| ) | ||
|
|
||
| func init() { | ||
| SchemeBuilder.Register(&HTTP01Proxy{}, &HTTP01ProxyList{}) | ||
| } | ||
|
|
||
| // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object | ||
| // +kubebuilder:object:root=true | ||
|
|
||
| // HTTP01ProxyList is a list of HTTP01Proxy objects. | ||
| type HTTP01ProxyList struct { | ||
| metav1.TypeMeta `json:",inline"` | ||
|
|
||
| // metadata is the standard list's metadata. | ||
| // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | ||
| metav1.ListMeta `json:"metadata"` | ||
| Items []HTTP01Proxy `json:"items"` | ||
| } | ||
|
|
||
| // +genclient | ||
| // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object | ||
| // +kubebuilder:object:root=true | ||
| // +kubebuilder:subresource:status | ||
| // +kubebuilder:resource:path=http01proxies,scope=Namespaced,categories={cert-manager-operator},shortName=http01proxy | ||
| // +kubebuilder:printcolumn:name="Mode",type="string",JSONPath=".spec.mode" | ||
| // +kubebuilder:printcolumn:name="Ready",type="string",JSONPath=".status.conditions[?(@.type=='Ready')].status" | ||
| // +kubebuilder:printcolumn:name="Message",type="string",JSONPath=".status.conditions[?(@.type=='Ready')].message" | ||
| // +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp" | ||
| // +kubebuilder:metadata:labels={"app.kubernetes.io/name=http01proxy", "app.kubernetes.io/part-of=cert-manager-operator"} | ||
|
|
||
| // HTTP01Proxy describes the configuration for the HTTP01 challenge proxy | ||
| // that redirects traffic from the API endpoint on port 80 to ingress routers. | ||
| // This enables cert-manager to perform HTTP01 ACME challenges for API endpoint certificates. | ||
| // The name must be `default` to make HTTP01Proxy a singleton. | ||
| // | ||
| // When an HTTP01Proxy is created, the proxy DaemonSet is deployed on control plane nodes. | ||
| // | ||
| // +kubebuilder:validation:XValidation:rule="self.metadata.name == 'default'",message="http01proxy is a singleton, .metadata.name must be 'default'" | ||
| // +operator-sdk:csv:customresourcedefinitions:displayName="HTTP01Proxy" | ||
| type HTTP01Proxy struct { | ||
| metav1.TypeMeta `json:",inline"` | ||
|
|
||
| // metadata is the standard object's metadata. | ||
| // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | ||
| metav1.ObjectMeta `json:"metadata,omitempty"` | ||
|
|
||
| // spec is the specification of the desired behavior of the HTTP01Proxy. | ||
| // +kubebuilder:validation:Required | ||
| // +required | ||
| Spec HTTP01ProxySpec `json:"spec"` | ||
|
|
||
| // status is the most recently observed status of the HTTP01Proxy. | ||
| // +kubebuilder:validation:Optional | ||
| // +optional | ||
| Status HTTP01ProxyStatus `json:"status,omitempty"` | ||
| } | ||
|
|
||
| // HTTP01ProxyMode controls how the HTTP01 challenge proxy is deployed. | ||
| // +kubebuilder:validation:Enum=DefaultDeployment;CustomDeployment | ||
| type HTTP01ProxyMode string | ||
|
|
||
| const ( | ||
| // HTTP01ProxyModeDefault enables the proxy with default configuration. | ||
| HTTP01ProxyModeDefault HTTP01ProxyMode = "DefaultDeployment" | ||
|
|
||
| // HTTP01ProxyModeCustom enables the proxy with user-specified configuration. | ||
| HTTP01ProxyModeCustom HTTP01ProxyMode = "CustomDeployment" | ||
| ) | ||
|
|
||
| // HTTP01ProxySpec is the specification of the desired behavior of the HTTP01Proxy. | ||
| // +kubebuilder:validation:XValidation:rule="self.mode == 'CustomDeployment' ? has(self.customDeployment) : !has(self.customDeployment)",message="customDeployment is required when mode is CustomDeployment and forbidden otherwise" | ||
| type HTTP01ProxySpec struct { | ||
| // mode controls whether the HTTP01 challenge proxy is active and how it should be deployed. | ||
| // DefaultDeployment enables the proxy with default configuration. | ||
| // CustomDeployment enables the proxy with user-specified configuration. | ||
| // +kubebuilder:validation:Required | ||
| // +required | ||
| Mode HTTP01ProxyMode `json:"mode"` | ||
|
|
||
| // customDeployment contains configuration options when mode is CustomDeployment. | ||
| // This field is only valid when mode is CustomDeployment. | ||
| // +kubebuilder:validation:Optional | ||
| // +optional | ||
| CustomDeployment *HTTP01ProxyCustomDeploymentSpec `json:"customDeployment,omitempty"` | ||
| } | ||
|
|
||
| // HTTP01ProxyCustomDeploymentSpec contains configuration for custom proxy deployment. | ||
| type HTTP01ProxyCustomDeploymentSpec struct { | ||
| // internalPort specifies the internal port used by the proxy service. | ||
| // Valid values are 1024-65535. | ||
| // +kubebuilder:validation:Minimum=1024 | ||
| // +kubebuilder:validation:Maximum=65535 | ||
| // +kubebuilder:default=8888 | ||
| // +optional | ||
| InternalPort int32 `json:"internalPort,omitempty"` | ||
| } | ||
|
|
||
| // HTTP01ProxyStatus is the most recently observed status of the HTTP01Proxy. | ||
| type HTTP01ProxyStatus struct { | ||
| // conditions holds information about the current state of the HTTP01 proxy deployment. | ||
| ConditionalStatus `json:",inline,omitempty"` | ||
|
|
||
| // proxyImage is the name of the image and the tag used for deploying the proxy. | ||
| ProxyImage string `json:"proxyImage,omitempty"` | ||
| } |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| apiVersion: rbac.authorization.k8s.io/v1 | ||
| kind: ClusterRole | ||
| metadata: | ||
| name: cert-manager-http01-proxy | ||
| labels: | ||
| app: cert-manager-http01-proxy | ||
| app.kubernetes.io/name: cert-manager-http01-proxy | ||
| app.kubernetes.io/part-of: cert-manager-operator | ||
| rules: | ||
| - apiGroups: | ||
| - config.openshift.io | ||
| resources: | ||
| - clusterversions | ||
| - infrastructures | ||
| - ingresses | ||
| verbs: | ||
| - get | ||
| - list | ||
| - watch | ||
| - apiGroups: | ||
| - operator.openshift.io | ||
| resources: | ||
| - machineconfigurations | ||
| verbs: | ||
| - update | ||
| - apiGroups: | ||
| - machineconfiguration.openshift.io | ||
| resources: | ||
| - machineconfigs | ||
| verbs: | ||
| - get | ||
| - list | ||
| - create | ||
| - update | ||
|
Comment on lines
+26
to
+34
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Tighten MachineConfig write permissions (least-privilege gap). This grants cluster-wide 🤖 Prompt for AI Agents |
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| apiVersion: rbac.authorization.k8s.io/v1 | ||
| kind: ClusterRoleBinding | ||
| metadata: | ||
| name: cert-manager-http01-proxy | ||
| labels: | ||
| app: cert-manager-http01-proxy | ||
| app.kubernetes.io/name: cert-manager-http01-proxy | ||
| app.kubernetes.io/part-of: cert-manager-operator | ||
| roleRef: | ||
| apiGroup: rbac.authorization.k8s.io | ||
| kind: ClusterRole | ||
| name: cert-manager-http01-proxy | ||
| subjects: | ||
| - kind: ServiceAccount | ||
| name: cert-manager-http01-proxy | ||
| namespace: cert-manager-operator |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| apiVersion: apps/v1 | ||
| kind: DaemonSet | ||
| metadata: | ||
| name: cert-manager-http01-proxy | ||
| namespace: cert-manager-operator | ||
| labels: | ||
| app: cert-manager-http01-proxy | ||
| app.kubernetes.io/name: cert-manager-http01-proxy | ||
| app.kubernetes.io/part-of: cert-manager-operator | ||
| spec: | ||
| selector: | ||
| matchLabels: | ||
| app: cert-manager-http01-proxy | ||
| updateStrategy: | ||
| type: RollingUpdate | ||
| template: | ||
| metadata: | ||
| labels: | ||
| app: cert-manager-http01-proxy | ||
| app.kubernetes.io/name: cert-manager-http01-proxy | ||
| app.kubernetes.io/part-of: cert-manager-operator | ||
| spec: | ||
| serviceAccountName: cert-manager-http01-proxy | ||
| hostNetwork: true | ||
|
Comment on lines
+23
to
+24
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🧩 Analysis chain🌐 Web query:
💡 Result: No, Kubernetes NetworkPolicies do not reliably apply to Pods running with hostNetwork: true. The official Kubernetes documentation states that NetworkPolicy behavior for hostNetwork pods is undefined, depending on the CNI plugin implementation. In the most common case, hostNetwork pods are ignored by podSelectors and treated as node/host traffic since they share the host's network namespace and IP. CNIs like Calico explicitly do not apply standard k8s NetworkPolicies to them, recommending host endpoints instead. Citations:
This pod joins the node network namespace, so the NetworkPolicies created for the feature will not provide the isolation they appear to promise. Kubernetes NetworkPolicies do not reliably apply to pods with 🤖 Prompt for AI Agents |
||
| nodeSelector: | ||
| node-role.kubernetes.io/master: "" | ||
| tolerations: | ||
| - key: node-role.kubernetes.io/master | ||
| operator: Exists | ||
| effect: NoSchedule | ||
| - key: node-role.kubernetes.io/control-plane | ||
| operator: Exists | ||
| effect: NoSchedule | ||
| containers: | ||
| - name: http01-proxy | ||
| image: ${RELATED_IMAGE_CERT_MANAGER_HTTP01PROXY} | ||
| ports: | ||
| - name: proxy | ||
| containerPort: 8888 | ||
| hostPort: 8888 | ||
| protocol: TCP | ||
| env: | ||
| - name: PROXY_PORT | ||
| value: "8888" | ||
| securityContext: | ||
| allowPrivilegeEscalation: false | ||
| capabilities: | ||
| add: | ||
| - NET_ADMIN | ||
| drop: | ||
| - ALL | ||
| runAsNonRoot: false | ||
| resources: | ||
|
coderabbitai[bot] marked this conversation as resolved.
|
||
| requests: | ||
| cpu: 10m | ||
| memory: 32Mi | ||
| limits: | ||
| cpu: 100m | ||
| memory: 64Mi | ||
| priorityClassName: system-cluster-critical | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| apiVersion: rbac.authorization.k8s.io/v1 | ||
| kind: ClusterRoleBinding | ||
| metadata: | ||
| name: cert-manager-http01-proxy-scc | ||
| labels: | ||
| app: cert-manager-http01-proxy | ||
| app.kubernetes.io/name: cert-manager-http01-proxy | ||
| app.kubernetes.io/part-of: cert-manager-operator | ||
| roleRef: | ||
| apiGroup: rbac.authorization.k8s.io | ||
| kind: ClusterRole | ||
| name: system:openshift:scc:privileged | ||
| subjects: | ||
| - kind: ServiceAccount | ||
| name: cert-manager-http01-proxy | ||
| namespace: cert-manager-operator |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| apiVersion: v1 | ||
| kind: ServiceAccount | ||
| metadata: | ||
| name: cert-manager-http01-proxy | ||
| namespace: cert-manager-operator | ||
| labels: | ||
| app: cert-manager-http01-proxy | ||
| app.kubernetes.io/name: cert-manager-http01-proxy | ||
| app.kubernetes.io/part-of: cert-manager-operator |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Avoid mutable
latestfor the HTTP01 proxy image.Using
:latesthere makes local runs non-reproducible and can silently pull unreviewed bits; it also conflicts with the explicitHTTP01PROXY_OPERAND_IMAGE_VERSION=0.1.0. Pin this to a fixed tag (or digest) and keep both variables aligned.Suggested fix
📝 Committable suggestion
🤖 Prompt for AI Agents