diff --git a/Makefile b/Makefile
index 397402c..d5544dc 100644
--- a/Makefile
+++ b/Makefile
@@ -38,7 +38,7 @@ kubernetes:
all: manager
# Run tests
-test: generate fmt vet manifests lint
+test: generate fmt vet manifests lint api-docs
go test ./... -coverprofile cover.out
# Build manager binary
@@ -87,6 +87,26 @@ docker-build:
docker-push:
docker push ${IMG}
+# Generate API reference documentation
+api-docs: gen-crd-api-reference-docs
+ $(API_REF_GEN) -api-dir=./pkg/api/v1 -config=./hack/api-docs/config.json -template-dir=./hack/api-docs/template -out-file=./docs/api/sipcluster.md
+
+# Find or download gen-crd-api-reference-docs
+gen-crd-api-reference-docs:
+ifeq (, $(shell which gen-crd-api-reference-docs))
+ @{ \
+ set -e ;\
+ API_REF_GEN_TMP_DIR=$$(mktemp -d) ;\
+ cd $$API_REF_GEN_TMP_DIR ;\
+ go mod init tmp ;\
+ go get github.com/ahmetb/gen-crd-api-reference-docs@v0.2.0 ;\
+ rm -rf $$API_REF_GEN_TMP_DIR ;\
+ }
+API_REF_GEN=$(GOBIN)/gen-crd-api-reference-docs
+else
+API_REF_GEN=$(shell which gen-crd-api-reference-docs)
+endif
+
# find or download controller-gen
# download controller-gen if necessary
controller-gen:
diff --git a/docs/api/sipcluster.md b/docs/api/sipcluster.md
new file mode 100644
index 0000000..e638bf4
--- /dev/null
+++ b/docs/api/sipcluster.md
@@ -0,0 +1,461 @@
+SIPCluster API reference
+Packages:
+
+airship.airshipit.org/v1
+Package v1 contains API Schema definitions for the airship v1 API group
+Resource Types:
+
+InfraConfig
+
+
+(Appears on:
+SIPClusterSpec)
+
+
+InfraService
+(string alias)
+
+(Appears on:
+InfraConfig)
+
+InfraService describes the type of infrastructure service that should be deployed when a sub-cluster is provisioned.
+NodeSet
+
+
+(Appears on:
+SIPClusterSpec)
+
+NodeSet are the the list of Nodes objects workers,
+or master that definee eexpectations
+for the Tenant Clusters
+Includes artifacts to associate with each defined namespace
+Such as :
+- Roles for the Nodes
+- Flavor for theh Nodes image
+- Scheduling expectations
+- Scale of the group of Nodes
+
+OptsConfig
+
+
+(Appears on:
+InfraConfig)
+
+
+SIPCluster
+
+SIPCluster is the Schema for the sipclusters API
+
+SIPClusterSpec
+
+
+(Appears on:
+SIPCluster)
+
+SIPClusterSpec defines the desired state of a SIPCluster
+
+SIPClusterStatus
+
+
+(Appears on:
+SIPCluster)
+
+SIPClusterStatus defines the observed state of SIPCluster
+
+SpreadTopology
+(string alias)
+
+(Appears on:
+NodeSet)
+
+VMCount
+
+
+(Appears on:
+NodeSet)
+
+VMCount
+
+VMRoles
+(string alias)
+VMRoles defines the states the provisioner will report
+the tenant has having.
+
+
This page was automatically generated with gen-crd-api-reference-docs
+
+
+ {{ fieldName . }}
+
+ {{ if linkForType .Type }}
+
+ {{ typeDisplayName .Type }}
+
+ {{ else }}
+ {{ typeDisplayName .Type }}
+ {{ end }}
+
+ |
+
+ {{ if fieldEmbedded . }}
+
+ (Members of {{ fieldName . }} are embedded into this type.)
+
+ {{ end}}
+
+ {{ if isOptionalMember .}}
+ (Optional)
+ {{ end }}
+
+ {{ safe (renderComments .CommentLines) }}
+
+ {{ if and (eq (.Type.Name.Name) "ObjectMeta") }}
+ Refer to the Kubernetes API documentation for the fields of the
+ metadata field.
+ {{ end }}
+
+ {{ if or (eq (fieldName .) "spec") }}
+
+
+
+ {{ template "members" .Type }}
+
+ {{ end }}
+ |
+
+ {{ end }}
+ {{ end }}
+{{ end }}
diff --git a/hack/api-docs/template/pkg.tpl b/hack/api-docs/template/pkg.tpl
new file mode 100644
index 0000000..f6972a6
--- /dev/null
+++ b/hack/api-docs/template/pkg.tpl
@@ -0,0 +1,46 @@
+{{ define "packages" }}
+ SIPCluster API reference
+
+ {{ with .packages}}
+ Packages:
+
+ {{ end}}
+
+ {{ range .packages }}
+
+ {{- packageDisplayName . -}}
+
+
+ {{ with (index .GoPackages 0 )}}
+ {{ with .DocComments }}
+ {{ safe (renderComments .) }}
+ {{ end }}
+ {{ end }}
+
+ Resource Types:
+
+
+ {{- range (visibleTypes (sortedTypes .Types)) -}}
+ {{ if isExportedType . -}}
+ -
+ {{ typeDisplayName . }}
+
+ {{- end }}
+ {{- end -}}
+
+
+ {{ range (visibleTypes (sortedTypes .Types))}}
+ {{ template "type" . }}
+ {{ end }}
+ {{ end }}
+
+
+
This page was automatically generated with gen-crd-api-reference-docs
+
+ {{- .Name.Name }}
+ {{ if eq .Kind "Alias" }}({{.Underlying}} alias){{ end -}}
+
+
+ {{ with (typeReferences .) }}
+
+ (Appears on:
+ {{- $prev := "" -}}
+ {{- range . -}}
+ {{- if $prev -}}, {{ end -}}
+ {{ $prev = . }}
+ {{ typeDisplayName . }}
+ {{- end -}}
+ )
+
+ {{ end }}
+
+ {{ with .CommentLines }}
+ {{ safe (renderComments .) }}
+ {{ end }}
+
+ {{ if .Members }}
+
+ {{ end }}
+{{ end }}
diff --git a/pkg/api/v1/doc.go b/pkg/api/v1/doc.go
new file mode 100644
index 0000000..80dcdba
--- /dev/null
+++ b/pkg/api/v1/doc.go
@@ -0,0 +1,20 @@
+/*
+
+
+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 v1 contains API Schema definitions for the airship v1 API group
+// +kubebuilder:object:generate=true
+// +groupName=airship.airshipit.org
+package v1
diff --git a/pkg/api/v1/groupversion_info.go b/pkg/api/v1/groupversion_info.go
index 55462d0..27762a2 100644
--- a/pkg/api/v1/groupversion_info.go
+++ b/pkg/api/v1/groupversion_info.go
@@ -14,9 +14,6 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-// Package v1 contains API Schema definitions for the airship v1 API group
-// +kubebuilder:object:generate=true
-// +groupName=airship.airshipit.org
package v1
import (
diff --git a/tools/whitespace_linter b/tools/whitespace_linter
index 280cef5..7b07925 100755
--- a/tools/whitespace_linter
+++ b/tools/whitespace_linter
@@ -2,7 +2,7 @@
# git 1.9.0+ allows for exclusions in pathspecs via ':!foo' syntax.
# However, until git 2.13.0 there must be at least one "inclusive" pathspec, hence the './*'
-trailing_whitespace=$(git grep -E -n -- ' +$' -- './*' ':!*.png')
+trailing_whitespace=$(git grep -E -n -- ' +$' -- './*' ':!*.png' ':!docs/api/sipcluster.md')
if [[ -n "$trailing_whitespace" ]]; then
printf "ERROR: Trailing whitespaces:\n"