Merge branch 'main' into fix_e2e_tests

kvalliyurnatt · web-flow · commit 66a228cada61 · 2025-03-06T11:31:43.000-05:00
diff --git a/config/recipes/istio-gateway/README.asciidoc b/config/recipes/istio-gateway/README.asciidoc
@@ -12,18 +12,14 @@ NOTE: These manifests were tested with ECK 1.0.1, Istio 1.5.0, and Kubernetes 1.
 
 == Prerequisites
 
-- Install Istio with the Secret Discovery Service (SDS) enabled
+- Install Istio with ingress gateway enabled (default profile) and for demonstration purposes we enable proxy logging
 +
 [source,sh]
 ----
-istioctl manifest generate \
-  --set values.global.mtls.enabled=true \
-  --set values.global.sds.enabled=true \
-  --set values.kiali.enabled=true \
-  --set values.global.proxy.accessLogFile="/dev/stdout" \
-  --set values.gateways.istio-egressgateway.enabled=false \
-  --set values.gateways.istio-ingressgateway.sds.enabled=true | kubectl apply -f -
+istioctl install --set meshConfig.accessLogFile=/dev/stdout
 ----
+
+
 - Install ECK with the Istio sidecar. See: https://www.elastic.co/guide/en/cloud-on-k8s/current/k8s-service-mesh-istio.html
 - Enforce mTLS
 +
@@ -118,7 +114,7 @@ Send a request to Elasticsearch
 ----
 curl -k \
 	--resolve "elasticsearch.ekmnt:$SECURE_INGRESS_PORT:$INGRESS_HOST" \
-	-u "elastic:$ELASTICSEARCH_PASSWORD" \
+	-u "elastic:$ELASTIC_PASSWORD" \
 	"https://elasticsearch.ekmnt:$SECURE_INGRESS_PORT/_cat/health?v"
 ----
 
diff --git a/docs/advanced-topics/service-meshes.asciidoc b/docs/advanced-topics/service-meshes.asciidoc
@@ -5,7 +5,7 @@ link:https://www.elastic.co/guide/en/cloud-on-k8s/master/k8s-{page_id}.html[View
 ****
 endif::[]
 
-:istio_version: 1.6.1
+:istio_version: 1.24.3
 :linkerd_version: 2.7.0
 
 [id="{p}-{page_id}"]
diff --git a/docs/docset.yml b/docs/docset.yml
diff --git a/docs/reference/api-docs.asciidoc b/docs/reference/api-docs.asciidoc
diff --git a/docs/reference/api-docs.md b/docs/reference/api-docs.md
diff --git a/docs/reference/index.md b/docs/reference/index.md
@@ -0,0 +1,13 @@
+---
+mapped_pages:
+  - https://www.elastic.co/guide/en/cloud-on-k8s/current/k8s-reference.html
+applies_to:
+  deployment:
+    eck: all
+---
+
+# Elastic Cloud on Kubernetes [k8s-reference]
+
+This section contains reference information for {{eck}}, including:
+
+* [API Reference](./api-docs.md)
diff --git a/docs/reference/toc.yml b/docs/reference/toc.yml
@@ -0,0 +1,3 @@
+toc:
+  - file: index.md
+  - file: api-docs.md
diff --git a/docs/release-notes/2.16.0.asciidoc b/docs/release-notes/2.16.0.asciidoc
@@ -4,7 +4,11 @@
 [[release-notes-2.16.0]]
 == {n} version 2.16.0
 
+[[breaking-2.16.0]]
+[float]
+=== Breaking changes
 
+* The initContainer for Kibana was renamed from `elastic-internal-init-config` to `elastic-internal-init` which could cause issues when a user has overridden the `podtemplate.spec.initContainers` with custom values. The recommendation is to link:https://www.elastic.co/guide/en/cloud-on-k8s/current/k8s-troubleshooting-methods.html#k8s-exclude-resource[exclude the Kibana resource from reconciliation] temporarily during upgrade of ECK and adjust the Kibana manifest to match the new initContainer name. After the ECK upgrade is complete remove the managed annotation from the Kibana manifest. {issue}8426[#8426]
 
 [[feature-2.16.0]]
 [float]
diff --git a/hack/api-docs/build.sh b/hack/api-docs/build.sh
@@ -37,9 +37,9 @@ build_docs() {
         echo "Generating API reference documentation"
         "${BIN_DIR}"/crd-ref-docs --source-path="${REPO_ROOT}"/pkg/apis \
             --config="${SCRIPT_DIR}"/config.yaml \
-            --renderer=asciidoctor \
+            --renderer=markdown \
             --templates-dir="${SCRIPT_DIR}"/templates \
-            --output-path="${DOCS_DIR}"/reference/api-docs.asciidoc
+            --output-path="${DOCS_DIR}"/reference/api-docs.md
     )
 }
 
diff --git a/hack/api-docs/templates/gv_details.tpl b/hack/api-docs/templates/gv_details.tpl
@@ -1,14 +1,15 @@
 {{- define "gvDetails" -}}
 {{- $gv := . -}}
-[id="{{ asciidocGroupVersionID $gv | asciidocRenderAnchorID }}"]
-== {{ $gv.GroupVersionString }}
+
+% TODO add function to crd-ref-docs return anchor used in links docs-v3 does not seem to produce valid markdown anchors
+## {{ $gv.GroupVersionString }} [#{{ markdownGroupVersionID $gv | replace "-" "" }}]
 
 {{ $gv.Doc }}
 
 {{- if $gv.Kinds  }}
-.Resource Types
+### Resource Types
 {{- range $gv.SortedKinds }}
-- {{ $gv.TypeForKind . | asciidocRenderTypeLink }}
+- {{ $gv.TypeForKind . | markdownRenderTypeLink }}
 {{- end }}
 {{ end }}
 
diff --git a/hack/api-docs/templates/gv_list.tpl b/hack/api-docs/templates/gv_list.tpl
@@ -1,22 +1,20 @@
 {{- define "gvList" -}}
 {{- $groupVersions := . -}}
+---
+mapped_pages:
+  - https://www.elastic.co/guide/en/cloud-on-k8s/current/k8s-api-reference.html
+navigation_title: API Reference
+applies_to:
+  deployment:
+    eck: all
+---
+% Generated documentation. Please do not edit.
 
-// Generated documentation. Please do not edit.
-:page_id: api-reference
-:anchor_prefix: k8s-api
+# {{`{{eck}}`}} API Reference [k8s-api-reference]
 
-ifdef::env-github[]
-****
-link:https://www.elastic.co/guide/en/cloud-on-k8s/master/k8s-{page_id}.html[View this document on the Elastic website]
-****
-endif::[]
-
-[id="{p}-{page_id}"]
-= API Reference
-
-.Packages
+## Packages
 {{- range $groupVersions }}
-- {{ asciidocRenderGVLink . }}
+* {{ markdownRenderGVLink . }}
 {{- end }}
 
 {{ range $groupVersions }}
diff --git a/hack/api-docs/templates/type.tpl b/hack/api-docs/templates/type.tpl
@@ -1,34 +1,31 @@
 {{- define "type" -}}
 {{- $type := . -}}
-{{- if asciidocShouldRenderType $type -}}
+{{- if markdownShouldRenderType $type -}}
 
-[id="{{ asciidocTypeID $type | asciidocRenderAnchorID }}"]
-=== {{ $type.Name  }} {{ if $type.IsAlias }}({{ asciidocRenderTypeLink $type.UnderlyingType  }}) {{ end }}
+### {{ $type.Name  }} {{ if $type.IsAlias }}({{ markdownRenderTypeLink $type.UnderlyingType  }}) {{ end }} [#{{ $type.Name | lower }}]
 
 {{ $type.Doc }}
 
 {{ if $type.References -}}
-.Appears In:
-****
+:::{admonition} Appears In:
 {{- range $type.SortedReferences }}
-- {{ asciidocRenderTypeLink . }}
+* {{ markdownRenderTypeLink . }}
 {{- end }}
-****
+
+:::
 {{- end }}
 
 {{ if $type.Members -}}
-[cols="25a,75a", options="header"]
-|===
-| Field | Description
+| Field | Description |
+| --- | --- |
 {{ if $type.GVK -}}
-| *`apiVersion`* __string__ | `{{ $type.GVK.Group }}/{{ $type.GVK.Version }}`
-| *`kind`* __string__ | `{{ $type.GVK.Kind }}`
+| *`apiVersion`* __string__ | `{{ $type.GVK.Group }}/{{ $type.GVK.Version }}` |
+| *`kind`* __string__ | `{{ $type.GVK.Kind }}` | 
 {{ end -}}
 
 {{ range $type.Members -}}
-| *`{{ .Name  }}`* __{{ asciidocRenderType .Type }}__ | {{ template "type_members" . }}
+| *`{{ .Name  }}`* __{{ markdownRenderType .Type }}__ | {{ template "type_members" . }} |
 {{ end -}}
-|===
 {{ end -}}
 
 {{- end -}}
diff --git a/hack/api-docs/templates/type_members.tpl b/hack/api-docs/templates/type_members.tpl
@@ -2,7 +2,7 @@
 {{- $field := . -}}
 {{- if eq $field.Name "metadata" -}}
 Refer to Kubernetes API documentation for fields of `metadata`.
-{{ else -}}
-{{ $field.Doc }}
+{{- else -}}
+{{ $field.Doc | replace "\n" "<br>" }}
 {{- end -}}
 {{- end -}}

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+toc:`
	`2`	`+ - file: index.md`
	`3`	`+ - file: api-docs.md`
Original file line number	Diff line number	Diff line change
`@@ -37,9 +37,9 @@ build_docs() {`
`37`	`37`	`echo "Generating API reference documentation"`
`38`	`38`	`"${BIN_DIR}"/crd-ref-docs --source-path="${REPO_ROOT}"/pkg/apis \`
`39`	`39`	`--config="${SCRIPT_DIR}"/config.yaml \`
`40`		`- --renderer=asciidoctor \`
	`40`	`+ --renderer=markdown \`
`41`	`41`	`--templates-dir="${SCRIPT_DIR}"/templates \`
`42`		`- --output-path="${DOCS_DIR}"/reference/api-docs.asciidoc`
	`42`	`+ --output-path="${DOCS_DIR}"/reference/api-docs.md`
`43`	`43`	`)`
`44`	`44`	`}`
`45`	`45`