Skip to content

Commit

Permalink
Merge pull request #71 from zoetrope/conditions
Browse files Browse the repository at this point in the history 
MarkdownViewStatusでmetav1.Conditionsを使うように修正
  • Loading branch information
@zoetrope
zoetrope committed Aug 19, 2024
2 parents f5b96d1 + d8c9315 commit 6d2168d
Show file tree
Hide file tree
Showing 21 changed files with 660 additions and 175 deletions.
21 changes: 12 additions & 9 deletions codes/20_manifests/api/v1/markdownview_types.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,30 +52,33 @@ type MarkdownViewSpec struct {
//! [status]

// MarkdownViewStatus defines the observed state of MarkdownView
// +kubebuilder:validation:Enum=NotReady;Available;Healthy
type MarkdownViewStatus string
type MarkdownViewStatus struct {
// Conditions represent the latest available observations of an object's state
// +listType=map
// +listMapKey=type
// +optional
Conditions []metav1.Condition `json:"conditions,omitempty"`
}

const (
MarkdownViewNotReady = MarkdownViewStatus("NotReady")
MarkdownViewAvailable = MarkdownViewStatus("Available")
MarkdownViewHealthy = MarkdownViewStatus("Healthy")
TypeMarkdownViewAvailable = "Available"
TypeMarkdownViewDegraded = "Degraded"
)

//! [status]

//! [markdown-view]
// +kubebuilder:object:root=true
// +kubebuilder:subresource:status
// +kubebuilder:printcolumn:name="REPLICAS",type="integer",JSONPath=".spec.replicas"
// +kubebuilder:printcolumn:name="STATUS",type="string",JSONPath=".status"
// +kubebuilder:printcolumn:name="Replicas",type="integer",JSONPath=".spec.replicas"
// +kubebuilder:printcolumn:name="Available",type="string",JSONPath=".status.conditions[?(@.type==\"Available\")].status"

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

Spec MarkdownViewSpec `json:"spec,omitempty"`
// +kubebuilder:default=NotReady
Spec MarkdownViewSpec `json:"spec,omitempty"`
Status MarkdownViewStatus `json:"status,omitempty"`
}

Expand Down
24 changes: 24 additions & 0 deletions codes/20_manifests/api/v1/zz_generated.deepcopy.go
View file

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

88 changes: 79 additions & 9 deletions codes/20_manifests/config/crd/bases/view.zoetrope.github.io_markdownviews.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ spec:
versions:
- additionalPrinterColumns:
- jsonPath: .spec.replicas
name: REPLICAS
name: Replicas
type: integer
- jsonPath: .status
name: STATUS
- jsonPath: .status.conditions[?(@.type=="Available")].status
name: Available
type: string
name: v1
schema:
Expand Down Expand Up @@ -65,13 +65,83 @@ spec:
type: string
type: object
status:
default: NotReady
description: MarkdownViewStatus defines the observed state of MarkdownView
enum:
- NotReady
- Available
- Healthy
type: string
properties:
conditions:
description: Conditions represent the latest available observations
of an object's state
items:
description: "Condition contains details for one aspect of the current
state of this API Resource.\n---\nThis struct is intended for
direct use as an array at the field path .status.conditions. For
example,\n\n\n\ttype FooStatus struct{\n\t // Represents the
observations of a foo's current state.\n\t // Known .status.conditions.type
are: \"Available\", \"Progressing\", and \"Degraded\"\n\t //
+patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t
\ // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\"
patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t
\ // other fields\n\t}"
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.
format: date-time
type: string
message:
description: |-
message is a human readable message indicating details about the transition.
This may be an empty string.
maxLength: 32768
type: string
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.
format: int64
minimum: 0
type: integer
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.
maxLength: 1024
minLength: 1
pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
type: string
status:
description: status of the condition, one of True, False, Unknown.
enum:
- "True"
- "False"
- Unknown
type: string
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)
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])$
type: string
required:
- lastTransitionTime
- message
- reason
- status
- type
type: object
type: array
x-kubernetes-list-map-keys:
- type
x-kubernetes-list-type: map
type: object
type: object
served: true
storage: true
Expand Down
21 changes: 12 additions & 9 deletions codes/30_client/api/v1/markdownview_types.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,30 +52,33 @@ type MarkdownViewSpec struct {
//! [status]

// MarkdownViewStatus defines the observed state of MarkdownView
// +kubebuilder:validation:Enum=NotReady;Available;Healthy
type MarkdownViewStatus string
type MarkdownViewStatus struct {
// Conditions represent the latest available observations of an object's state
// +listType=map
// +listMapKey=type
// +optional
Conditions []metav1.Condition `json:"conditions,omitempty"`
}

const (
MarkdownViewNotReady = MarkdownViewStatus("NotReady")
MarkdownViewAvailable = MarkdownViewStatus("Available")
MarkdownViewHealthy = MarkdownViewStatus("Healthy")
TypeMarkdownViewAvailable = "Available"
TypeMarkdownViewDegraded = "Degraded"
)

//! [status]

//! [markdown-view]
// +kubebuilder:object:root=true
// +kubebuilder:subresource:status
// +kubebuilder:printcolumn:name="REPLICAS",type="integer",JSONPath=".spec.replicas"
// +kubebuilder:printcolumn:name="STATUS",type="string",JSONPath=".status"
// +kubebuilder:printcolumn:name="Replicas",type="integer",JSONPath=".spec.replicas"
// +kubebuilder:printcolumn:name="Available",type="string",JSONPath=".status.conditions[?(@.type==\"Available\")].status"

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

Spec MarkdownViewSpec `json:"spec,omitempty"`
// +kubebuilder:default=NotReady
Spec MarkdownViewSpec `json:"spec,omitempty"`
Status MarkdownViewStatus `json:"status,omitempty"`
}

Expand Down
24 changes: 24 additions & 0 deletions codes/30_client/api/v1/zz_generated.deepcopy.go
View file

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

88 changes: 79 additions & 9 deletions codes/30_client/config/crd/bases/view.zoetrope.github.io_markdownviews.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ spec:
versions:
- additionalPrinterColumns:
- jsonPath: .spec.replicas
name: REPLICAS
name: Replicas
type: integer
- jsonPath: .status
name: STATUS
- jsonPath: .status.conditions[?(@.type=="Available")].status
name: Available
type: string
name: v1
schema:
Expand Down Expand Up @@ -65,13 +65,83 @@ spec:
type: string
type: object
status:
default: NotReady
description: MarkdownViewStatus defines the observed state of MarkdownView
enum:
- NotReady
- Available
- Healthy
type: string
properties:
conditions:
description: Conditions represent the latest available observations
of an object's state
items:
description: "Condition contains details for one aspect of the current
state of this API Resource.\n---\nThis struct is intended for
direct use as an array at the field path .status.conditions. For
example,\n\n\n\ttype FooStatus struct{\n\t // Represents the
observations of a foo's current state.\n\t // Known .status.conditions.type
are: \"Available\", \"Progressing\", and \"Degraded\"\n\t //
+patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t
\ // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\"
patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t
\ // other fields\n\t}"
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.
format: date-time
type: string
message:
description: |-
message is a human readable message indicating details about the transition.
This may be an empty string.
maxLength: 32768
type: string
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.
format: int64
minimum: 0
type: integer
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.
maxLength: 1024
minLength: 1
pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
type: string
status:
description: status of the condition, one of True, False, Unknown.
enum:
- "True"
- "False"
- Unknown
type: string
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)
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])$
type: string
required:
- lastTransitionTime
- message
- reason
- status
- type
type: object
type: array
x-kubernetes-list-map-keys:
- type
x-kubernetes-list-type: map
type: object
type: object
served: true
storage: true
Expand Down
Loading

0 comments on commit 6d2168d

Please sign in to comment.