Skip to content
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

Added ability to configure Helm chart repository accessible within cluster #598

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 2 additions & 1 deletion Makefile
Expand Up @@ -20,6 +20,7 @@ GO_LD_FLAGS:=
# $4 - output
$(call add-crd-gen,authorization,./authorization/v1,./authorization/v1,./authorization/v1)
$(call add-crd-gen,config,./config/v1,./config/v1,./config/v1)
$(call add-crd-gen,helm,./helm/v1beta1,./helm/v1beta1,./helm/v1beta1)
$(call add-crd-gen,console,./console/v1,./console/v1,./console/v1)
$(call add-crd-gen,imageregistry,./imageregistry/v1,./imageregistry/v1,./imageregistry/v1)
$(call add-crd-gen,operator,./operator/v1,./operator/v1,./operator/v1)
Expand Down Expand Up @@ -52,4 +53,4 @@ update: update-scripts update-codegen-crds

generate-with-container: Dockerfile.build
$(RUNTIME) build -t $(RUNTIME_IMAGE_NAME) -f Dockerfile.build .
$(RUNTIME) run -ti --rm -v $(PWD):/go/src/github.com/openshift/api:z -w /go/src/github.com/openshift/api $(RUNTIME_IMAGE_NAME) make update-scripts
$(RUNTIME) run -ti --rm -v $(PWD):/go/src/github.com/openshift/api:z -w /go/src/github.com/openshift/api $(RUNTIME_IMAGE_NAME) make update
2 changes: 1 addition & 1 deletion hack/update-deepcopy.sh
Expand Up @@ -10,7 +10,7 @@ verify="${VERIFY:-}"
GOFLAGS="" bash ${CODEGEN_PKG}/generate-groups.sh "deepcopy" \
github.com/openshift/api/generated \
github.com/openshift/api \
"apps:v1 authorization:v1 build:v1 config:v1 console:v1 image:v1,docker10,dockerpre012 imageregistry:v1 kubecontrolplane:v1 legacyconfig:v1 network:v1 oauth:v1 openshiftcontrolplane:v1 operator:v1 operator:v1alpha1 operatorcontrolplane:v1alpha1 operatoringress:v1 osin:v1 project:v1 quota:v1 route:v1 samples:v1 security:v1 servicecertsigner:v1alpha1 template:v1 user:v1" \
"apps:v1 authorization:v1 build:v1 config:v1 helm:v1beta1 console:v1 image:v1,docker10,dockerpre012 imageregistry:v1 kubecontrolplane:v1 legacyconfig:v1 network:v1 oauth:v1 openshiftcontrolplane:v1 operator:v1 operator:v1alpha1 operatorcontrolplane:v1alpha1 operatoringress:v1 osin:v1 project:v1 quota:v1 route:v1 samples:v1 security:v1 servicecertsigner:v1alpha1 template:v1 user:v1" \
--go-header-file ${SCRIPT_ROOT}/hack/empty.txt \
${verify}

1 change: 1 addition & 0 deletions hack/verify-crds.sh
Expand Up @@ -8,6 +8,7 @@ fi

FILES="authorization/v1/*.crd.yaml
config/v1/*.crd.yaml
helm/v1beta1/*.crd.yaml
console/v1/*.crd.yaml
imageregistry/v1/*crd.yaml
operator/v1/*.crd.yaml
Expand Down
26 changes: 26 additions & 0 deletions helm/install.go
@@ -0,0 +1,26 @@
package helm

import (
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/runtime/schema"

helmv1beta1 "github.com/openshift/api/helm/v1beta1"
)

const (
GroupName = "helm.openshift.io"
)

var (
schemeBuilder = runtime.NewSchemeBuilder(helmv1beta1.Install)
// Install is a function which adds every version of this group to a scheme
Install = schemeBuilder.AddToScheme
)

func Resource(resource string) schema.GroupResource {
return schema.GroupResource{Group: GroupName, Resource: resource}
}

func Kind(kind string) schema.GroupKind {
return schema.GroupKind{Group: GroupName, Kind: kind}
}
167 changes: 167 additions & 0 deletions helm/v1beta1/0000_10-helm-chart-repository.crd.yaml
@@ -0,0 +1,167 @@
apiVersion: apiextensions.k8s.io/v1beta1
kind: CustomResourceDefinition
metadata:
name: helmchartrepositories.helm.openshift.io
spec:
scope: Cluster
preserveUnknownFields: false
group: helm.openshift.io
names:
kind: HelmChartRepository
listKind: HelmChartRepositoryList
plural: helmchartrepositories
singular: helmchartrepository
versions:
- name: v1beta1
served: true
storage: true
subresources:
status: {}
"validation":
"openAPIV3Schema":
description: HelmChartRepository holds cluster-wide configuration for proxied
Helm chart repository
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
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 cluster..
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])$
8 changes: 8 additions & 0 deletions helm/v1beta1/doc.go
@@ -0,0 +1,8 @@
// +k8s:deepcopy-gen=package,register
// +k8s:defaulter-gen=TypeMeta
// +k8s:openapi-gen=true

// +kubebuilder:validation:Optional
// +groupName=helm.openshift.io
// Package v1 is the v1 version of the API.
package v1beta1
38 changes: 38 additions & 0 deletions helm/v1beta1/register.go
@@ -0,0 +1,38 @@
package v1beta1

import (
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/runtime/schema"
)

var (
GroupName = "helm.openshift.io"
GroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1beta1"}
schemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
// Install is a function which adds this version to a scheme
Install = schemeBuilder.AddToScheme

// SchemeGroupVersion generated code relies on this name
// Deprecated
SchemeGroupVersion = GroupVersion
// AddToScheme exists solely to keep the old generators creating valid code
// DEPRECATED
AddToScheme = schemeBuilder.AddToScheme
)

// Resource generated code relies on this being here, but it logically belongs to the group
// DEPRECATED
func Resource(resource string) schema.GroupResource {
return schema.GroupResource{Group: GroupName, Resource: resource}
}

// Adds the list of known types to api.Scheme.
func addKnownTypes(scheme *runtime.Scheme) error {
scheme.AddKnownTypes(GroupVersion,
&HelmChartRepository{},
&HelmChartRepositoryList{},
)
metav1.AddToGroupVersion(scheme, GroupVersion)
return nil
}
84 changes: 84 additions & 0 deletions helm/v1beta1/types_helm.go
@@ -0,0 +1,84 @@
package v1beta1

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

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

// HelmChartRepository holds cluster-wide configuration for proxied Helm chart repository
type HelmChartRepository struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`

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

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

// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
type HelmChartRepositoryList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata"`

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

// Helm chart repository exposed within the cluster
type HelmChartRepositorySpec struct {

// Optional associated human readable repository name, it can be used by UI for displaying purposes
// +kubebuilder:validation:MinLength=1
pedjak marked this conversation as resolved.
Show resolved Hide resolved
// +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
pedjak marked this conversation as resolved.
Show resolved Hide resolved
// +kubebuilder:validation:MaxLength=2048
// +optional
Description string `json:"description,omitempty"`

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

type ConnectionConfig struct {

// Chart repository URL
// +kubebuilder:validation:Pattern=`^https?:\/\/`
pedjak marked this conversation as resolved.
Show resolved Hide resolved
// +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 HelmChartRepositoryStatus struct {

// conditions is a list of conditions and their statuses
// +optional
Conditions []metav1.Condition `json:"conditions,omitempty"`
}