Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/suggest_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -101,5 +101,5 @@ jobs:
export PR_NUMBER="${{ github.event.issue.number }}"
echo "Updated PR_NUMBER: '$PR_NUMBER'"
fi
python scripts/suggest_docs.py

python scripts/suggest_docs.py
283 changes: 153 additions & 130 deletions config/crd/bases/appstudio.redhat.com_releaseplanadmissions.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.8.0
creationTimestamp: null
controller-gen.kubebuilder.io/version: v0.14.0
name: releaseplanadmissions.appstudio.redhat.com
spec:
group: appstudio.redhat.com
Expand All @@ -24,30 +23,26 @@ spec:
- jsonPath: .spec.origin
name: Origin
type: string
- jsonPath: .spec.approvalMode
name: Approval
type: string
- jsonPath: .status.phase
name: Phase
type: string
- jsonPath: .spec.autoRelease
name: Auto-Release
type: boolean
name: v1alpha1
schema:
openAPIV3Schema:
description: ReleasePlanAdmission is the Schema for the ReleasePlanAdmissions
API. This resource controls approval workflows and automated release processes for applications.
API.
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'
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'
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
Expand All @@ -60,98 +55,140 @@ spec:
items:
type: string
type: array
approvalMode:
description: ApprovalMode defines the approval process for releases (manual, automatic, or policy-based)
enum:
- manual
- automatic
- policy-based
type: string
autoRelease:
description: AutoRelease enables automatic release creation when conditions are met
type: boolean
collectors:
description: Collectors contains all the information of the collectors
to be executed as part of the release workflow
properties:
items:
description: Items is the list of Collectors to be executed as
part of the release workflow
items:
description: |-
CollectorItem represents all the information about an specific collector which will be executed in the
CollectorsPipeline.
properties:
name:
description: Name of the collector
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
type: string
params:
description: Params is a slice of parameters for a given
collector
items:
description: Param represents a parameter for a collector
properties:
name:
description: Name is the name of the parameter
type: string
value:
description: Value is the value of the parameter
type: string
required:
- name
- value
type: object
type: array
timeout:
description: Timeout in seconds for the collector to execute
type: integer
type:
description: Type is the type of collector to be used
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
type: string
required:
- name
- params
- type
type: object
type: array
serviceAccountName:
description: ServiceAccountName is the ServiceAccount to use during
the execution of the Collectors Pipeline
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
type: string
required:
- items
type: object
data:
description: Data is an unstructured key used for providing data for
the release Pipeline
the managed Release Pipeline
type: object
x-kubernetes-preserve-unknown-fields: true
environment:
description: Environment defines which Environment will be used to
release the Application
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
type: string
notificationConfig:
description: NotificationConfig defines notification settings for release events
properties:
channels:
description: Channels specifies where notifications should be sent (e.g., slack, email)
items:
type: string
type: array
events:
description: Events specifies which events trigger notifications
items:
enum:
- release-started
- release-completed
- release-failed
- approval-required
type: string
type: array
type: object
origin:
description: Origin references where the release requests should come
from
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
type: string
pipelineRef:
description: PipelineRef is a reference to the Pipeline to be executed
by the release PipelineRun
pipeline:
description: Pipeline contains all the information about the managed
Pipeline
properties:
params:
description: Params is a slice of parameters for a given resolver
items:
description: Param defines the parameters for a given resolver
in PipelineRef
properties:
name:
description: Name is the name of the parameter
type: string
value:
description: Value is the value of the parameter
type: string
required:
- name
- value
type: object
type: array
resolver:
description: Resolver is the name of a Tekton resolver to be used
(e.g. git)
type: string
timeout:
default: "0"
description: Timeout is value to use to override the tekton default
Pipelinerun timeout
pipelineRef:
description: PipelineRef is the reference to the Pipeline
properties:
params:
description: Params is a slice of parameters for a given resolver
items:
description: Param defines the parameters for a given resolver
in PipelineRef
properties:
name:
description: Name is the name of the parameter
type: string
value:
description: Value is the value of the parameter
type: string
required:
- name
- value
type: object
type: array
resolver:
description: Resolver is the name of a Tekton resolver to
be used (e.g. git)
type: string
required:
- params
- resolver
type: object
serviceAccountName:
description: ServiceAccountName is the ServiceAccount to use during
the execution of the Pipeline
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
type: string
timeouts:
description: Timeouts defines the different Timeouts to use in
the PipelineRun execution
properties:
finally:
description: Finally sets the maximum allowed duration of
this pipeline's finally
type: string
pipeline:
description: Pipeline sets the maximum allowed duration for
execution of the entire pipeline. The sum of individual
timeouts for tasks and finally must not exceed this value.
type: string
tasks:
description: Tasks sets the maximum allowed duration of this
pipeline's tasks
type: string
type: object
required:
- params
- resolver
- pipelineRef
type: object
policy:
description: Policy to validate before releasing an artifact
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
type: string
serviceAccount:
description: ServiceAccount is the name of the service account to
use in the release PipelineRun to gain elevated privileges
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
type: string
required:
- applications
- approvalMode
- origin
- pipelineRef
- policy
type: object
status:
Expand All @@ -163,42 +200,42 @@ spec:
for the releasePlanAdmission
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,
\n 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 }"
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.
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.
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.
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.
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
Expand All @@ -212,11 +249,12 @@ spec:
- 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)
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
Expand Down Expand Up @@ -245,24 +283,9 @@ spec:
type: string
type: object
type: array
phase:
description: Phase represents the current phase of the ReleasePlanAdmission (e.g., Active, Pending, Disabled, Error)
enum:
- Active
- Pending
- Disabled
- Error
- Validating
type: string
type: object
type: object
served: true
storage: true
subresources:
status: {}
status:
acceptedNames:
kind: ""
plural: ""
conditions: []
storedVersions: []
status: {}
Loading