Skip to content

Commit

Permalink
helm: add a new namespaced CRD for helm
Browse files Browse the repository at this point in the history
As part of the process to support namespace-scoped Helm repositories for
non-admin users, this PR adds a new namespace-scoped CRD definition
named `projecthelmchartrepositories.helm.openshift.io`.

Closes: https://issues.redhat.com/browse/HELM-258
Signed-off-by: Allen Bai <abai@redhat.com>
  • Loading branch information
Allen Bai committed Dec 13, 2021
1 parent 6e0b1eb commit 2c3a771
Show file tree
Hide file tree
Showing 5 changed files with 342 additions and 0 deletions.
129 changes: 129 additions & 0 deletions helm/v1beta1/0000_10-project-helm-chart-repository.crd.yaml
@@ -0,0 +1,129 @@
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
include.release.openshift.io/ibm-cloud-managed: "true"
include.release.openshift.io/self-managed-high-availability: "true"
include.release.openshift.io/single-node-developer: "true"
name: projecthelmchartrepositories.helm.openshift.io
spec:
group: helm.openshift.io
names:
kind: ProjectHelmChartRepository
listKind: ProjectHelmChartRepositoryList
plural: projecthelmchartrepositories
singular: projecthelmchartrepository
scope: Namespaced
versions:
- name: v1beta1
served: true
storage: true
subresources:
status: {}
schema:
openAPIV3Schema:
description: "ProjectHelmChartRepository holds namespace-wide configuration for proxied Helm chart repository \n Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer)."
type: object
required:
- spec
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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
spec:
description: spec holds user settable values for configuration
type: object
properties:
connectionConfig:
description: Required configuration for connecting to the chart repo
type: object
properties:
ca:
description: ca is an optional reference to a config map by name containing the PEM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key "ca-bundle.crt" is used to locate the data. If empty, the default system roots are used. The namespace for this config map is openshift-config.
type: object
required:
- name
properties:
name:
description: name is the metadata.name of the referenced config map
type: string
tlsClientConfig:
description: tlsClientConfig is an optional reference to a secret by name that contains the PEM-encoded TLS client certificate and private key to present when connecting to the server. The key "tls.crt" is used to locate the client certificate. The key "tls.key" is used to locate the private key. The namespace for this secret is openshift-config.
type: object
required:
- name
properties:
name:
description: name is the metadata.name of the referenced secret
type: string
url:
description: Chart repository URL
type: string
maxLength: 2048
pattern: ^https?:\/\/
description:
description: Optional human readable repository description, it can be used by UI for displaying purposes
type: string
maxLength: 2048
minLength: 1
disabled:
description: If set to true, disable the repo usage in the namespace
type: boolean
name:
description: Optional associated human readable repository name, it can be used by UI for displaying purposes
type: string
maxLength: 100
minLength: 1
status:
description: Observed status of the repository within the namespace..
type: object
properties:
conditions:
description: conditions is a list of conditions and their statuses
type: array
items:
description: "Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"` \n // other fields }"
type: object
required:
- lastTransitionTime
- message
- reason
- status
- type
properties:
lastTransitionTime:
description: lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
type: string
format: date-time
message:
description: message is a human readable message indicating details about the transition. This may be an empty string.
type: string
maxLength: 32768
observedGeneration:
description: observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
type: integer
format: int64
minimum: 0
reason:
description: reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
type: string
maxLength: 1024
minLength: 1
pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
status:
description: status of the condition, one of True, False, Unknown.
type: string
enum:
- "True"
- "False"
- Unknown
type:
description: type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)
type: string
maxLength: 316
pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
2 changes: 2 additions & 0 deletions helm/v1beta1/register.go
Expand Up @@ -32,6 +32,8 @@ func addKnownTypes(scheme *runtime.Scheme) error {
scheme.AddKnownTypes(GroupVersion,
&HelmChartRepository{},
&HelmChartRepositoryList{},
&ProjectHelmChartRepository{},
&ProjectHelmChartRepositoryList{},
)
metav1.AddToGroupVersion(scheme, GroupVersion)
return nil
Expand Down
File renamed without changes.
92 changes: 92 additions & 0 deletions helm/v1beta1/types_project_helm_chart_repository.go
@@ -0,0 +1,92 @@
package v1beta1

import (
configv1 "github.com/openshift/api/config/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

// +genclient
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// +kubebuilder:plural=projecthelmchartrepositories

// ProjectHelmChartRepository holds namespace-wide configuration for proxied Helm chart repository
//
// Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).
// +openshift:compatibility-gen:level=2
type ProjectHelmChartRepository struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`

// spec holds user settable values for configuration
// +kubebuilder:validation:Required
// +required
Spec ProjectHelmChartRepositorySpec `json:"spec"`

// Observed status of the repository within the namespace..
// +optional
Status ProjectHelmChartRepositoryStatus `json:"status"`
}

// Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// +openshift:compatibility-gen:level=2
type ProjectHelmChartRepositoryList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata"`

Items []ProjectHelmChartRepository `json:"items"`
}

// Helm chart repository exposed within the namespace
type ProjectHelmChartRepositorySpec struct {

// If set to true, disable the repo usage in the namespace
// +optional
Disabled bool `json:"disabled,omitempty"`

// Optional associated human readable repository name, it can be used by UI for displaying purposes
// +kubebuilder:validation:MinLength=1
// +kubebuilder:validation:MaxLength=100
// +optional
DisplayName string `json:"name,omitempty"`

// Optional human readable repository description, it can be used by UI for displaying purposes
// +kubebuilder:validation:MinLength=1
// +kubebuilder:validation:MaxLength=2048
// +optional
Description string `json:"description,omitempty"`

// Required configuration for connecting to the chart repo
ProjectConnectionConfig ProjectConnectionConfig `json:"connectionConfig"`
}

type ProjectConnectionConfig struct {

// Chart repository URL
// +kubebuilder:validation:Pattern=`^https?:\/\/`
// +kubebuilder:validation:MaxLength=2048
URL string `json:"url"`

// ca is an optional reference to a config map by name containing the PEM-encoded CA bundle.
// It is used as a trust anchor to validate the TLS certificate presented by the remote server.
// The key "ca-bundle.crt" is used to locate the data.
// If empty, the default system roots are used.
// The namespace for this config map is openshift-config.
// +optional
CA configv1.ConfigMapNameReference `json:"ca,omitempty"`

// tlsClientConfig is an optional reference to a secret by name that contains the
// PEM-encoded TLS client certificate and private key to present when connecting to the server.
// The key "tls.crt" is used to locate the client certificate.
// The key "tls.key" is used to locate the private key.
// The namespace for this secret is openshift-config.
// +optional
TLSClientConfig configv1.SecretNameReference `json:"tlsClientConfig,omitempty"`
}

type ProjectHelmChartRepositoryStatus struct {

// conditions is a list of conditions and their statuses
// +optional
Conditions []metav1.Condition `json:"conditions,omitempty"`
}
119 changes: 119 additions & 0 deletions helm/v1beta1/zz_generated.deepcopy.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 2c3a771

Please sign in to comment.