k8s_apis_sync.yaml

name: k8s_apis_sync

on:
  workflow_dispatch:
    inputs:
      release:
        type: string
        required: true
        description: ''
      bucket_folder:
        type: string
        required: true
        description: ''

jobs:
  k8s_apis_sync:
    runs-on: ubuntu-latest
    permissions:
      id-token: write
      contents: write
      pull-requests: write
      actions: write
    steps:
      - name: Generate a token
        id: generate-token
        uses: actions/create-github-app-token@v1
        with:
          app-id: ${{ secrets.DOCS_APP_ID }}
          private-key: ${{ secrets.DOCS_APP_PRIVATE_KEY }}

      - name: 'Checkout'
        uses: actions/checkout@v3
        with:
          token: ${{ steps.generate-token.outputs.token }}

      - name: 'Install crdoc'
        run: |-
          curl -LO https://github.com/fybrik/crdoc/releases/download/v0.6.3/crdoc_Linux_x86_64.tar.gz
          tar -xvzf crdoc_Linux_x86_64.tar.gz
          sudo mv crdoc /bin/crdoc

      - name: Configure AWS credentials
        uses: aws-actions/configure-aws-credentials@v4
        with:
          role-to-assume: arn:aws:iam::022044324644:role/GitHubRedisDocsS3Access
          aws-region: us-east-1

      - name: 'Fetch release'
        env:
          RELEASE: ${{ github.event.inputs.release }}
          BUCKET_FOLDER: ${{ github.event.inputs.bucket_folder }}
        run: |-
          aws s3 cp "s3://redislabs-k8s/${BUCKET_FOLDER}/redis-enterprise-operator-${RELEASE}.tar.gz" .

          tar xf "redis-enterprise-operator-${RELEASE}.tar.gz"

      - name: 'Generate READMEs'
        run: |-
          mkdir artifacts
          mkdir templates
          cp content/operate/kubernetes/reference/api/kubernetes-api-reference-template.tmpl templates/template.tmpl

          crdoc --resources crds/reaadb_crd.yaml --output artifacts/redis_enterprise_active_active_database_api.md --template templates/template.tmpl
          sed -E -i 's/^### RedisEnterpriseActiveActiveDatabase\./### /g' artifacts/redis_enterprise_active_active_database_api.md
          sed -E -i 's/^<sup><sup>\[↩ Parent\]\(#redisenterpriseactiveactivedatabase/<sup><sup>\[↩ Parent\]\(#/g' artifacts/redis_enterprise_active_active_database_api.md
          sed -E -i 's/<td><a href="#redisenterpriseactiveactivedatabase/<td><a href="#/' artifacts/redis_enterprise_active_active_database_api.md
          sed -E -i 's/\[index\]/\[\]/g' artifacts/redis_enterprise_active_active_database_api.md
          awk '/(#[^")]+)index/ {gsub(/index/,"")}; {print}' artifacts/redis_enterprise_active_active_database_api.md > _tmp.md && mv _tmp.md artifacts/redis_enterprise_active_active_database_api.md

          crdoc --resources crds/rec_crd.yaml --output artifacts/redis_enterprise_cluster_api.md --template templates/template.tmpl
          sed -E -i 's/^### RedisEnterpriseCluster\./### /g' artifacts/redis_enterprise_cluster_api.md
          sed -E -i 's/^<sup><sup>\[↩ Parent\]\(#redisenterprisecluster/<sup><sup>\[↩ Parent\]\(#/g' artifacts/redis_enterprise_cluster_api.md
          sed -E -i 's/<td><a href="#redisenterprisecluster/<td><a href="#/' artifacts/redis_enterprise_cluster_api.md
          sed -E -i 's/\[index\]/\[\]/g' artifacts/redis_enterprise_cluster_api.md
          awk '/(#[^")]+)index/ {gsub(/index/,"")}; {print}' artifacts/redis_enterprise_cluster_api.md > _tmp.md && mv _tmp.md artifacts/redis_enterprise_cluster_api.md

          crdoc --resources crds/redb_crd.yaml --output artifacts/redis_enterprise_database_api.md --template templates/template.tmpl
          sed -E -i 's/^### RedisEnterpriseDatabase\./### /g' artifacts/redis_enterprise_database_api.md
          sed -E -i 's/^<sup><sup>\[↩ Parent\]\(#redisenterprisedatabase/<sup><sup>\[↩ Parent\]\(#/g' artifacts/redis_enterprise_database_api.md
          sed -E -i 's/<td><a href="#redisenterprisedatabase/<td><a href="#/' artifacts/redis_enterprise_database_api.md
          sed -E -i 's/\[index\]/\[\]/g' artifacts/redis_enterprise_database_api.md
          awk '/(#[^")]+)index/ {gsub(/index/,"")}; {print}' artifacts/redis_enterprise_database_api.md > _tmp.md && mv _tmp.md artifacts/redis_enterprise_database_api.md

          crdoc --resources crds/rerc_crd.yaml --output artifacts/redis_enterprise_remote_cluster_api.md --template templates/template.tmpl
          sed -E -i 's/^### RedisEnterpriseRemoteCluster\./### /g' artifacts/redis_enterprise_remote_cluster_api.md
          sed -E -i 's/^<sup><sup>\[↩ Parent\]\(#redisenterpriseremotecluster/<sup><sup>\[↩ Parent\]\(#/g' artifacts/redis_enterprise_remote_cluster_api.md
          sed -E -i 's/<td><a href="#redisenterpriseremotecluster/<td><a href="#/' artifacts/redis_enterprise_remote_cluster_api.md
          sed -E -i 's/\[index\]/\[\]/g' artifacts/redis_enterprise_remote_cluster_api.md
          awk '/(#[^")]+)index/ {gsub(/index/,"")}; {print}' artifacts/redis_enterprise_remote_cluster_api.md > _tmp.md && mv _tmp.md artifacts/redis_enterprise_remote_cluster_api.md

          crdoc --resources crds/reacl_crd.yaml --output artifacts/redis_enterprise_acl_api.md --template templates/template.tmpl
          sed -E -i 's/^### RedisEnterpriseACL\./### /g' artifacts/redis_enterprise_acl_api.md
          sed -E -i 's/^<sup><sup>\[↩ Parent\]\(#redisenterpriseacl/<sup><sup>\[↩ Parent\]\(#/g' artifacts/redis_enterprise_acl_api.md
          sed -E -i 's/<td><a href="#redisenterpriseacl/<td><a href="#/' artifacts/redis_enterprise_acl_api.md
          sed -E -i 's/\[index\]/\[\]/g' artifacts/redis_enterprise_acl_api.md
          awk '/(#[^")]+)index/ {gsub(/index/,"")}; {print}' artifacts/redis_enterprise_acl_api.md > _tmp.md && mv _tmp.md artifacts/redis_enterprise_acl_api.md

          crdoc --resources crds/recrole_crd.yaml --output artifacts/redis_enterprise_cluster_role_api.md --template templates/template.tmpl
          sed -E -i 's/^### RedisEnterpriseClusterRole\./### /g' artifacts/redis_enterprise_cluster_role_api.md
          sed -E -i 's/^<sup><sup>\[↩ Parent\]\(#redisenterpriseclusterrole/<sup><sup>\[↩ Parent\]\(#/g' artifacts/redis_enterprise_cluster_role_api.md
          sed -E -i 's/<td><a href="#redisenterpriseclusterrole/<td><a href="#/' artifacts/redis_enterprise_cluster_role_api.md
          sed -E -i 's/\[index\]/\[\]/g' artifacts/redis_enterprise_cluster_role_api.md
          awk '/(#[^")]+)index/ {gsub(/index/,"")}; {print}' artifacts/redis_enterprise_cluster_role_api.md > _tmp.md && mv _tmp.md artifacts/redis_enterprise_cluster_role_api.md

          crdoc --resources crds/recrolebinding_crd.yaml --output artifacts/redis_enterprise_cluster_role_binding_api.md --template templates/template.tmpl
          sed -E -i 's/^### RedisEnterpriseClusterRoleBinding\./### /g' artifacts/redis_enterprise_cluster_role_binding_api.md
          sed -E -i 's/^<sup><sup>\[↩ Parent\]\(#redisenterpriseclusterrolebinding/<sup><sup>\[↩ Parent\]\(#/g' artifacts/redis_enterprise_cluster_role_binding_api.md
          sed -E -i 's/<td><a href="#redisenterpriseclusterrolebinding/<td><a href="#/' artifacts/redis_enterprise_cluster_role_binding_api.md
          sed -E -i 's/\[index\]/\[\]/g' artifacts/redis_enterprise_cluster_role_binding_api.md
          awk '/(#[^")]+)index/ {gsub(/index/,"")}; {print}' artifacts/redis_enterprise_cluster_role_binding_api.md > _tmp.md && mv _tmp.md artifacts/redis_enterprise_cluster_role_binding_api.md

          crdoc --resources crds/redbrole_crd.yaml --output artifacts/redis_enterprise_database_role_api.md --template templates/template.tmpl
          sed -E -i 's/^### RedisEnterpriseDatabaseRole\./### /g' artifacts/redis_enterprise_database_role_api.md
          sed -E -i 's/^<sup><sup>\[↩ Parent\]\(#redisenterprisedatabaserole/<sup><sup>\[↩ Parent\]\(#/g' artifacts/redis_enterprise_database_role_api.md
          sed -E -i 's/<td><a href="#redisenterprisedatabaserole/<td><a href="#/' artifacts/redis_enterprise_database_role_api.md
          sed -E -i 's/\[index\]/\[\]/g' artifacts/redis_enterprise_database_role_api.md
          awk '/(#[^")]+)index/ {gsub(/index/,"")}; {print}' artifacts/redis_enterprise_database_role_api.md > _tmp.md && mv _tmp.md artifacts/redis_enterprise_database_role_api.md

          crdoc --resources crds/redbrolebinding_crd.yaml --output artifacts/redis_enterprise_database_role_binding_api.md --template templates/template.tmpl
          sed -E -i 's/^### RedisEnterpriseDatabaseRoleBinding\./### /g' artifacts/redis_enterprise_database_role_binding_api.md
          sed -E -i 's/^<sup><sup>\[↩ Parent\]\(#redisenterprisedatabaserolebinding/<sup><sup>\[↩ Parent\]\(#/g' artifacts/redis_enterprise_database_role_binding_api.md
          sed -E -i 's/<td><a href="#redisenterprisedatabaserolebinding/<td><a href="#/' artifacts/redis_enterprise_database_role_binding_api.md
          sed -E -i 's/\[index\]/\[\]/g' artifacts/redis_enterprise_database_role_binding_api.md
          awk '/(#[^")]+)index/ {gsub(/index/,"")}; {print}' artifacts/redis_enterprise_database_role_binding_api.md > _tmp.md && mv _tmp.md artifacts/redis_enterprise_database_role_binding_api.md

          crdoc --resources crds/reuser_crd.yaml --output artifacts/redis_enterprise_user_api.md --template templates/template.tmpl
          sed -E -i 's/^### RedisEnterpriseUser\./### /g' artifacts/redis_enterprise_user_api.md
          sed -E -i 's/^<sup><sup>\[↩ Parent\]\(#redisenterpriseuser/<sup><sup>\[↩ Parent\]\(#/g' artifacts/redis_enterprise_user_api.md
          sed -E -i 's/<td><a href="#redisenterpriseuser/<td><a href="#/' artifacts/redis_enterprise_user_api.md
          sed -E -i 's/\[index\]/\[\]/g' artifacts/redis_enterprise_user_api.md
          awk '/(#[^")]+)index/ {gsub(/index/,"")}; {print}' artifacts/redis_enterprise_user_api.md > _tmp.md && mv _tmp.md artifacts/redis_enterprise_user_api.md

      - name: 'Remove fields without description'
        run: |-
          file="artifacts/redis_enterprise_cluster_api.md"
          empty_fields_file="content/operate/kubernetes/reference/api/redis_enterprise_cluster_empty_fields"

          # Read empty fields and process them
          while IFS= read -r field; do
              # Skip empty lines and comments
              [[ -z "$field" || "$field" =~ ^# ]] && continue

              # Convert field path to section header pattern
              section_pattern="${field}"

              # Remove subsections that go deeper than [index] level
              # Keep: spec.extraEnvVars
              # Keep: spec.extraEnvVars[index]
              # Remove: spec.extraEnvVars[index].valueFrom
              # Remove: spec.extraEnvVars[index].valueFrom.fieldRef
              awk -v base_pattern="${section_pattern}" '
              BEGIN { skip = 0 }
              /^### / {
                  # Check if this line matches a pattern we want to remove
                  section = $0
                  gsub(/^### /, "", section)

                  # If it starts with our base pattern
                  if (index(section, base_pattern) == 1) {
                      remainder = substr(section, length(base_pattern) + 1)

                      # If remainder is empty, keep it (main section)
                      if (remainder == "") {
                          skip = 0
                      }
                      # If remainder is just [index], keep it
                      else if (remainder == "[index]") {
                          skip = 0
                      }
                      # If remainder starts with [index]. (has more after [index]), remove it
                      else if (index(remainder, "[index].") == 1) {
                          skip = 1
                          next
                      }
                      # If remainder starts with . (direct subsection), remove it
                      else if (index(remainder, ".") == 1) {
                          skip = 1
                          next
                      }
                      # If remainder starts with []. (direct subsection), remove it
                      else if (index(remainder, "[].") == 1) {
                          skip = 1
                          next
                      }
                      # Otherwise keep it
                      else {
                          skip = 0
                      }
                  } else {
                      # Different section, stop skipping
                      skip = 0
                  }
              }

              skip == 0 { print }
              ' "$file" > "${file}.tmp" && mv "${file}.tmp" "$file"

          done < "$empty_fields_file"

      - name: 'Fix link titles'
        run: |-
          sed -E -i 's/linkTitle: RedisEnterpriseActiveActiveDatabase API Reference/linkTitle: REAADB API/g' artifacts/redis_enterprise_active_active_database_api.md
          sed -E -i 's/linkTitle: RedisEnterpriseCluster API Reference/linkTitle: REC API/g' artifacts/redis_enterprise_cluster_api.md
          sed -E -i 's/linkTitle: RedisEnterpriseDatabase API Reference/linkTitle: REDB API/g' artifacts/redis_enterprise_database_api.md
          sed -E -i 's/linkTitle: RedisEnterpriseRemoteCluster API Reference/linkTitle: RERC API/g' artifacts/redis_enterprise_remote_cluster_api.md
          sed -E -i 's/linkTitle: RedisEnterpriseACL API Reference/linkTitle: REACL API/g' artifacts/redis_enterprise_acl_api.md
          sed -E -i 's/linkTitle: RedisEnterpriseClusterRole API Reference/linkTitle: RECROLE API/g' artifacts/redis_enterprise_cluster_role_api.md
          sed -E -i 's/linkTitle: RedisEnterpriseClusterRoleBinding API Reference/linkTitle: RECROLEBINDING API/g' artifacts/redis_enterprise_cluster_role_binding_api.md
          sed -E -i 's/linkTitle: RedisEnterpriseDatabaseRole API Reference/linkTitle: REDBROLE API/g' artifacts/redis_enterprise_database_role_api.md
          sed -E -i 's/linkTitle: RedisEnterpriseDatabaseRoleBinding API Reference/linkTitle: REDBROLEBINDING API/g' artifacts/redis_enterprise_database_role_binding_api.md
          sed -E -i 's/linkTitle: RedisEnterpriseUser API Reference/linkTitle: REUSER API/g' artifacts/redis_enterprise_user_api.md

      - name: 'Generate YAML snippets'
        run: |-
          function formatYamlSnippet() {
          cat > "$2" << EOL
          \`\`\`yaml
          $(cat $1)
          \`\`\`
          EOL
          }

          formatYamlSnippet admission-service.yaml content/embeds/k8s/admission-service.md
          formatYamlSnippet admission/webhook.yaml content/embeds/k8s/admission_webhook.md
          formatYamlSnippet examples/v1/rec.yaml content/embeds/k8s/rec.md
          formatYamlSnippet examples/v1alpha1/reaadb.yaml content/embeds/k8s/reaadb.md
          formatYamlSnippet examples/v1alpha1/redb.yaml content/embeds/k8s/redb.md
          formatYamlSnippet examples/v1alpha1/rerc.yaml content/embeds/k8s/rerc.md
          formatYamlSnippet log_collector/log_collector_role_all_mode.yaml content/embeds/k8s/log_collector_role_all_mode.md
          formatYamlSnippet log_collector/log_collector_role_restricted_mode.yaml content/embeds/k8s/log_collector_role_restricted_mode.md
          formatYamlSnippet multi-namespace-redb/operator_cluster_role_binding.yaml content/embeds/k8s/multi-ns_operator_cluster_role_binding.md
          formatYamlSnippet multi-namespace-redb/operator_cluster_role.yaml content/embeds/k8s/multi-ns_operator_cluster_role.md
          formatYamlSnippet multi-namespace-redb/role_binding.yaml content/embeds/k8s/multi-ns_role_binding.md
          formatYamlSnippet multi-namespace-redb/role.yaml content/embeds/k8s/multi-ns_role.md
          formatYamlSnippet openshift/admission-service.yaml content/embeds/k8s/openshift_admission-service.md
          formatYamlSnippet openshift/rec_rhel.yaml content/embeds/k8s/openshift_rec.md
          formatYamlSnippet openshift/role_binding.yaml content/embeds/k8s/openshift_role_binding.md
          formatYamlSnippet openshift/role.yaml content/embeds/k8s/openshift_role.md
          formatYamlSnippet openshift/scc.yaml content/embeds/k8s/openshift_scc.md
          formatYamlSnippet openshift/service_account.yaml content/embeds/k8s/openshift_service_account.md
          formatYamlSnippet rack_awareness/rack_aware_cluster_role_binding.yaml content/embeds/k8s/rack_aware_cluster_role_binding.md
          formatYamlSnippet rack_awareness/rack_aware_cluster_role.yaml content/embeds/k8s/rack_aware_cluster_role.md
          formatYamlSnippet rack_awareness/rack_aware_rec.yaml content/embeds/k8s/rack_aware_rec.md
          formatYamlSnippet role_binding.yaml content/embeds/k8s/role_binding.md
          formatYamlSnippet role.yaml content/embeds/k8s/role.md
          formatYamlSnippet service_account.yaml content/embeds/k8s/service_account.md

      - name: 'Send pull request'
        env:
          GH_TOKEN: ${{ steps.generate-token.outputs.token }}
          RELEASE: ${{ github.event.inputs.release }}
        run: |-
          BRANCH="k8s_apis_docs_${RELEASE}"

          # Setup git email and username
          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
          git config user.name "github-actions[bot]"

          git checkout -b "${BRANCH}"

          cp artifacts/redis_enterprise_active_active_database_api.md content/operate/kubernetes/reference/api/
          cp artifacts/redis_enterprise_cluster_api.md content/operate/kubernetes/reference/api/
          cp artifacts/redis_enterprise_database_api.md content/operate/kubernetes/reference/api/
          cp artifacts/redis_enterprise_remote_cluster_api.md content/operate/kubernetes/reference/api/
          cp artifacts/redis_enterprise_acl_api.md content/operate/kubernetes/reference/api/
          cp artifacts/redis_enterprise_cluster_role_api.md content/operate/kubernetes/reference/api/
          cp artifacts/redis_enterprise_cluster_role_binding_api.md content/operate/kubernetes/reference/api/
          cp artifacts/redis_enterprise_database_role_api.md content/operate/kubernetes/reference/api/
          cp artifacts/redis_enterprise_database_role_binding_api.md content/operate/kubernetes/reference/api/
          cp artifacts/redis_enterprise_user_api.md content/operate/kubernetes/reference/api/

          git add content/operate/kubernetes/reference/api/
          git add content/embeds/k8s/

          git commit -m "k8s api docs ${RELEASE}"
          git push origin "${BRANCH}"

          gh pr create \
            --body "k8s api docs ${RELEASE}" \
            --title "k8s api docs ${RELEASE}" \
            --head "$BRANCH" \
            --base "main"