DOC/MAJOR: lifecycle: add lifecycle information about active versions

Author: oktalz

.aspell.yml

@@ -27,3 +27,4 @@ allowed:
   - linter
   - linters
   - tls
+  - lifecycle

documentation/README.md

@@ -10,6 +10,10 @@
 - [Annotations](annotations.md)
 - [Prometheus](prometheus.md)
 
+### Lifecycle
+
+- [Lifecycle](lifecycle.md)
+
 #### Experimental
 - [Gateway API](gateway-api.md)
 

documentation/gen/doc-gen

@@ -1,6 +1,6 @@
 module doc-gen
 
-go 1.15
+go 1.23
 
 require (
 	github.com/google/renameio v1.0.1

documentation/gen/go.mod

@@ -0,0 +1,56 @@
+package main
+
+import (
+	"fmt"
+	"log"
+	"strings"
+
+	"github.com/google/renameio"
+)
+
+type SupportVersion struct {
+	Version string   `yaml:"version"`
+	GA      string   `yaml:"ga"`
+	MinEOL  string   `yaml:"min_eol"`
+	HAProxy string   `yaml:"haproxy"`
+	K8S     []string `yaml:"k8s"`
+}
+
+type Support struct {
+	Versions []*SupportVersion `yaml:"versions"`
+}
+
+func (c *Conf) generateSupport() {
+	var buff strings.Builder
+	buff.WriteString(title)
+	// buff.WriteString(headerREADME)
+	buff.WriteByte('\n')
+	buff.WriteByte('\n')
+	buff.WriteString(`### Lifecycle`)
+	buff.WriteByte('\n')
+	buff.WriteByte('\n')
+	buff.WriteString(`| Version | GA | EOL | HAProxy | *k8s versions |`)
+	buff.WriteByte('\n')
+	buff.WriteString(`| -:|:-:|:-:|:-:|:-:|`)
+	buff.WriteByte('\n')
+
+	for _, version := range c.Support {
+		if version.HAProxy == "" {
+			version.HAProxy = version.Version
+		}
+		buff.WriteString(fmt.Sprintf(`| **%s** | %s | %s | %s | %s |`, version.Version, version.GA, version.MinEOL, version.HAProxy, strings.Join(version.K8S, ", ")))
+		buff.WriteByte('\n')
+	}
+
+	buff.WriteByte('\n')
+	buff.WriteString(`**Note:** for specific version of controller, only k8s versions that are thoroughly tested with that version are listed`)
+	buff.WriteByte('\n')
+	buff.WriteByte('\n')
+	buff.WriteString(`This is autogenerated from [lifecycle.yaml](lifecycle.yaml). Description can be found in [generator readme](gen/README.md)`)
+	buff.WriteByte('\n')
+
+	err := renameio.WriteFile("../lifecycle.md", []byte(buff.String()), 0o644)
+	if err != nil {
+		log.Println(err)
+	}
+}

documentation/gen/lifecycle.go

@@ -7,6 +7,7 @@ func main() {
 	cn.generateReadme()
 	cn.generateReadmeAnnotations()
 	cn.generateReadmeController()
+	cn.generateSupport()
 	// cn.saveConf()
 	// cn.saveDocConf()
 }

documentation/gen/main.go

@@ -22,6 +22,10 @@ var headerREADME = `
 - [Annotations](annotations.md)
 - [Prometheus](prometheus.md)
 
+### Lifecycle
+
+- [Lifecycle](lifecycle.md)
+
 #### Experimental
 - [Gateway API](gateway-api.md)
 

documentation/gen/readme.go

@@ -1,8 +1,8 @@
 package main
 
 import (
-	"io/ioutil"
 	"log"
+	"os"
 
 	"gopkg.in/yaml.v3"
 )
@@ -50,10 +50,11 @@ type Conf struct {
 	Arguments     []*ConfArg           `yaml:"image_arguments"`
 	Groups        map[string]ConfGroup `yaml:"groups"`
 	Items         []*ConfItem          `yaml:"annotations"`
+	Support       []*SupportVersion    `yaml:"versions"`
 }
 
 func (c *Conf) getConf() *Conf {
-	yamlFile, err := ioutil.ReadFile("../doc.yaml")
+	yamlFile, err := os.ReadFile("../doc.yaml")
 	if err != nil {
 		log.Printf("yamlFile.Get err   #%v ", err)
 	}
@@ -62,6 +63,17 @@ func (c *Conf) getConf() *Conf {
 		log.Fatalf("Unmarshal: %v", err)
 	}
 
+	yamlFile, err = os.ReadFile("../lifecycle.yaml")
+	if err != nil {
+		log.Printf("yamlFile.Get err   #%v ", err)
+	}
+	support := Support{}
+	err = yaml.Unmarshal(yamlFile, &support)
+	if err != nil {
+		log.Fatalf("Unmarshal: %v", err)
+	}
+	c.Support = support.Versions
+
 	return c
 }
 

documentation/gen/types.go

@@ -0,0 +1,18 @@
+
+# ![HAProxy](../assets/images/haproxy-weblogo-210x49.png "HAProxy")
+
+## HAProxy kubernetes ingress controller 
+
+### Lifecycle
+
+| Version | GA | EOL | HAProxy | *k8s versions |
+| -:|:-:|:-:|:-:|:-:|
+| **3.0** | 2024-06 | 2025-06 | 3.0 | 1.30, 1.29, 1.28 |
+| **1.11** | 2024-02 | 2025-02 | 2.8 | 1.28, 1.27, 1.26 |
+| **1.10** | 2023-04 | 2024-06 | 2.7 | 1.27, 1.26, 1.25 |
+| **1.9** | 2022-10 | 2023-11 | 2.6 | 1.25, 1.24, 1.23 |
+| **1.8** | 2022-06 | 2023-05 | 2.5 | 1.23, 1.22, 1.21 |
+
+**Note:** for specific version of controller, only k8s versions that are thoroughly tested with that version are listed
+
+This is autogenerated from [lifecycle.yaml](lifecycle.yaml). Description can be found in [generator readme](gen/README.md)

documentation/lifecycle.md

@@ -0,0 +1,40 @@
+versions:
+  - version: "3.0"
+    ga: 2024-06
+    min_eol: 2025-06
+    k8s:
+      - "1.30"
+      - "1.29"
+      - "1.28"
+  - version: "1.11"
+    ga: 2024-02
+    min_eol: 2025-02
+    k8s:
+      - "1.28"
+      - "1.27"
+      - "1.26"
+    haproxy: "2.8"
+  - version: "1.10"
+    ga: 2023-04
+    min_eol: 2024-06
+    k8s:
+      - "1.27"
+      - "1.26"
+      - "1.25"
+    haproxy: "2.7"
+  - version: "1.9"
+    ga: 2022-10
+    min_eol: 2023-11
+    k8s:
+      - "1.25"
+      - "1.24"
+      - "1.23"
+    haproxy: "2.6"
+  - version: "1.8"
+    ga: 2022-06
+    min_eol: 2023-05
+    k8s:
+      - "1.23"
+      - "1.22"
+      - "1.21"
+    haproxy: "2.5"