Skip to content

Commit

Permalink
feat: add NamespacedStore CRD
Browse files Browse the repository at this point in the history
  • Loading branch information
binbin-li committed Apr 24, 2024
1 parent 80dc17e commit 0d06ef6
Show file tree
Hide file tree
Showing 35 changed files with 1,462 additions and 119 deletions.
8 changes: 8 additions & 0 deletions PROJECT
Original file line number Diff line number Diff line change
Expand Up @@ -88,4 +88,12 @@ resources:
kind: NamespacedPolicy
path: github.com/deislabs/ratify/api/v1beta1
version: v1beta1
- api:
crdVersion: v1
namespaced: true
domain: ratify.deislabs.io
group: config
kind: NamespacedStore
path: github.com/deislabs/ratify/api/v1beta1
version: v1beta1
version: "3"
69 changes: 69 additions & 0 deletions api/unversioned/namespacedstore_types.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
/*
Copyright The Ratify Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package unversioned

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

// NamespacedStoreSpec defines the desired state of NamespacedStore
type NamespacedStoreSpec struct {
// Important: Run "make install-crds" to regenerate code after modifying this file

// Name of the store
Name string `json:"name"`
// Version of the store plugin. Optional
Version string `json:"version,omitempty"`
// Plugin path, optional
Address string `json:"address,omitempty"`
// OCI Artifact source to download the plugin from, optional
Source *PluginSource `json:"source,omitempty"`

// Parameters of the store
Parameters runtime.RawExtension `json:"parameters,omitempty"`
}

// NamespacedStoreStatus defines the observed state of NamespacedStore
type NamespacedStoreStatus struct {
// Important: Run "make install-crds" to regenerate code after modifying this file

// Is successful in finding the plugin
IsSuccess bool `json:"issuccess"`
// Error message if operation was unsuccessful
// +optional
Error string `json:"error,omitempty"`
// Truncated error message if the message is too long
// +optional
BriefError string `json:"brieferror,omitempty"`
}

// NamespacedStore is the Schema for the namespacedstores API
type NamespacedStore struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`

Spec NamespacedStoreSpec `json:"spec,omitempty"`
Status NamespacedStoreStatus `json:"status,omitempty"`
}

// NamespacedStoreList contains a list of NamespacedStore
type NamespacedStoreList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []NamespacedStore `json:"items"`
}
79 changes: 79 additions & 0 deletions api/unversioned/zz_generated.deepcopy.go

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

85 changes: 85 additions & 0 deletions api/v1beta1/namespacedstore_types.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
/*
Copyright The Ratify Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package v1beta1

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

// EDIT THIS FILE! THIS IS SCAFFOLDING FOR YOU TO OWN!
// NOTE: json tags are required. Any new fields you add must have json tags for the fields to be serialized.

// NamespacedStoreSpec defines the desired state of NamespacedStore
type NamespacedStoreSpec struct {
// Important: Run "make install-crds" to regenerate code after modifying this file

// Name of the store
Name string `json:"name"`
// Version of the store plugin. Optional
Version string `json:"version,omitempty"`
// Plugin path, optional
Address string `json:"address,omitempty"`
// OCI Artifact source to download the plugin from, optional
Source *PluginSource `json:"source,omitempty"`

// +kubebuilder:pruning:PreserveUnknownFields
// Parameters of the store
Parameters runtime.RawExtension `json:"parameters,omitempty"`
}

// NamespacedStoreStatus defines the observed state of NamespacedStore
type NamespacedStoreStatus struct {
// Important: Run "make install-crds" to regenerate code after modifying this file

// Is successful in finding the plugin
IsSuccess bool `json:"issuccess"`
// Error message if operation was unsuccessful
// +optional
Error string `json:"error,omitempty"`
// Truncated error message if the message is too long
// +optional
BriefError string `json:"brieferror,omitempty"`
}

// +kubebuilder:object:root=true
// +kubebuilder:resource:scope="Namespaced"
// +kubebuilder:subresource:status
// +kubebuilder:storageversion
// +kubebuilder:printcolumn:name="IsSuccess",type=boolean,JSONPath=`.status.issuccess`
// +kubebuilder:printcolumn:name="Error",type=string,JSONPath=`.status.brieferror`
// NamespacedStore is the Schema for the namespacedstores API
type NamespacedStore struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`

Spec NamespacedStoreSpec `json:"spec,omitempty"`
Status NamespacedStoreStatus `json:"status,omitempty"`
}

// +kubebuilder:object:root=true
// +kubebuilder:storageversion
// NamespacedStoreList contains a list of NamespacedStore
type NamespacedStoreList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []NamespacedStore `json:"items"`
}

func init() {
SchemeBuilder.Register(&NamespacedStore{}, &NamespacedStoreList{})
}
Loading

0 comments on commit 0d06ef6

Please sign in to comment.