diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index ce32ac7..504e330 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -11,6 +11,11 @@ repos: entry: make lint-fix language: system pass_filenames: false + - id: generate-apiref + name: generate-apiref + entry: make generate-apiref + language: system + pass_filenames: false - repo: https://github.com/google/yamlfmt rev: v0.10.0 hooks: @@ -20,7 +25,8 @@ repos: rev: v4.5.0 hooks: - id: trailing-whitespace + exclude: site/_pages/appwrapper.v1beta2.md - id: end-of-file-fixer - exclude: hack/boilerplate.go.txt + exclude: hack/boilerplate.go.txt|site/_pages/appwrapper.v1beta2.md - id: mixed-line-ending args: ["--fix=lf"] diff --git a/site/_pages/appwrapper.v1beta2.md b/site/_pages/appwrapper.v1beta2.md index 2fbeafd..8a4ccc7 100644 --- a/site/_pages/appwrapper.v1beta2.md +++ b/site/_pages/appwrapper.v1beta2.md @@ -2,13 +2,22 @@ permalink: /api/workload.codeflare.dev/v1beta2/ title: AppWrapper API classes: wide +description: Generated API reference documentation for workload.codeflare.dev/v1beta2. --- -Generated API reference documentation for . - ## Resource Types +- [AppWrapper](#workload-codeflare-dev-v1beta2-AppWrapper) +- [AppWrapperComponent](#workload-codeflare-dev-v1beta2-AppWrapperComponent) +- [AppWrapperComponentStatus](#workload-codeflare-dev-v1beta2-AppWrapperComponentStatus) +- [AppWrapperCondition](#workload-codeflare-dev-v1beta2-AppWrapperCondition) +- [AppWrapperList](#workload-codeflare-dev-v1beta2-AppWrapperList) +- [AppWrapperPhase](#workload-codeflare-dev-v1beta2-AppWrapperPhase) +- [AppWrapperPodSet](#workload-codeflare-dev-v1beta2-AppWrapperPodSet) +- [AppWrapperPodSetInfo](#workload-codeflare-dev-v1beta2-AppWrapperPodSetInfo) +- [AppWrapperSpec](#workload-codeflare-dev-v1beta2-AppWrapperSpec) +- [AppWrapperStatus](#workload-codeflare-dev-v1beta2-AppWrapperStatus) ## `AppWrapper` {#workload-codeflare-dev-v1beta2-AppWrapper} @@ -69,7 +78,7 @@ arbitrary metadata about the Component to customize its treatment by the AppWrap []AppWrapperPodSet -

PodSets contained in the Component

+

DeclaredPodSets for the Component (optional for known PodCreating GVKs)

podSetInfos
@@ -89,6 +98,64 @@ arbitrary metadata about the Component to customize its treatment by the AppWrap +## `AppWrapperComponentStatus` {#workload-codeflare-dev-v1beta2-AppWrapperComponentStatus} + + +**Appears in:** + +- [AppWrapperStatus](#workload-codeflare-dev-v1beta2-AppWrapperStatus) + + +

AppWrapperComponentStatus tracks the status of a single managed Component

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
name [Required]
+string +		 +

Name is the name of the Component

+
kind [Required]
+string +		 +

Kind is the Kind of the Component

+
apiVersion [Required]
+string +		 +

APIVersion is the APIVersion of the Component

+
podSets [Required]
+[]AppWrapperPodSet +		 +

PodSets is the validated PodSets for the Component (either from AppWrapperComponent.DeclaredPodSets or inferred by the controller)

+
conditions
+[]k8s.io/apimachinery/pkg/apis/meta/v1.Condition +		 +

Conditions hold the latest available observations of the Component's current state.

+

The type of the condition could be:

+
    +
  • ResourcesDeployed: The component is deployed on the cluster
    • +
+
+ ## `AppWrapperPhase` {#workload-codeflare-dev-v1beta2-AppWrapperPhase} (Alias of `string`) @@ -110,6 +177,8 @@ arbitrary metadata about the Component to customize its treatment by the AppWrap - [AppWrapperComponent](#workload-codeflare-dev-v1beta2-AppWrapperComponent) +- [AppWrapperComponentStatus](#workload-codeflare-dev-v1beta2-AppWrapperComponentStatus) +

AppWrapperPodSet describes an homogeneous set of pods

@@ -133,6 +202,14 @@ arbitrary metadata about the Component to customize its treatment by the AppWrap

Path is the path Component.Template to the PodTemplateSpec for this PodSet

+annotations
+map[string]string + + +

Annotations is an unstructured key value map that may be used to store and retrieve +arbitrary metadata about the PodSet to customize its treatment by the AppWrapper controller.

+ + @@ -180,6 +257,13 @@ arbitrary metadata about the Component to customize its treatment by the AppWrap

Tolerations to be added to the PodSpecTemplate

+schedulingGates
+[]k8s.io/api/core/v1.PodSchedulingGate + + +

SchedulingGates to be added to the PodSpecTemplate

+ + @@ -213,6 +297,13 @@ arbitrary metadata about the Component to customize its treatment by the AppWrap

Suspend suspends the AppWrapper when set to true

+managedBy [Required]
+string + + +

ManagedBy is used to indicate the controller or entity that manages the AppWrapper.

+ + @@ -261,5 +352,13 @@ arbitrary metadata about the Component to customize its treatment by the AppWrap +componentStatus [Required]
+[]AppWrapperComponentStatus + + +

ComponentStatus parallels the Components array in the Spec and tracks the actually deployed resources

+ + + \ No newline at end of file diff --git a/site/genref/markdown/members.tpl b/site/genref/markdown/members.tpl index b970218..e16f181 100644 --- a/site/genref/markdown/members.tpl +++ b/site/genref/markdown/members.tpl @@ -1,5 +1,5 @@ {{ define "members" }} - {{/* . is a apiType */}} +{{/* . is a apiType */}} {{- range .GetMembers -}} {{/* . is a apiMember */}} {{- if not .Hidden }} diff --git a/site/genref/markdown/pkg.tpl b/site/genref/markdown/pkg.tpl index aba8ba5..cbfc1e1 100644 --- a/site/genref/markdown/pkg.tpl +++ b/site/genref/markdown/pkg.tpl @@ -6,21 +6,18 @@ permalink: /api/{{ .DisplayName }}/ title: {{ .Title }} classes: wide +description: Generated API reference documentation for {{ .DisplayName }}. --- {{ .GetComment -}} {{- end -}} {{- end }} -Generated API reference documentation for {{ .GroupName }}. - ## Resource Types {{ range .packages -}} - {{- range .VisibleTypes -}} - {{- if .IsExported }} +{{- range .VisibleTypes -}} - [{{ .DisplayName }}]({{ .Link }}) - {{- end -}} - {{- end -}} +{{ end -}} {{- end -}} {{ range .packages -}} @@ -33,9 +30,8 @@ Generated API reference documentation for {{ .GroupName }}. {{ end }} {{ else }} {{/* For package w/o group name, list only types referenced. */}} - {{ $isConfig := (eq .GroupName "") }} {{- range .VisibleTypes -}} - {{- if or .Referenced $isConfig -}} + {{- if .Referenced -}} {{ template "type" . }} {{- end -}} {{- end }} diff --git a/site/genref/markdown/type.tpl b/site/genref/markdown/type.tpl index f64dbe6..196ccda 100644 --- a/site/genref/markdown/type.tpl +++ b/site/genref/markdown/type.tpl @@ -22,13 +22,12 @@ - {{/* . is a apiType */}} - {{- if .IsExported -}} +{{/* . is a apiType */}} +{{- if .IsExported -}} {{/* Add apiVersion and kind rows if deemed necessary */}} - {{ end -}} - +{{- end -}} {{/* The actual list of members is in the following template */}} {{- template "members" . -}}
FieldDescription
apiVersion
string		{{- .APIGroup -}}
kind
string		{{- .Name.Name -}}