Skip to content

Conversation

@nashtapu-tibco
Copy link
Contributor

This pull request makes significant improvements to the AKS cluster setup and control plane workshop documentation. The main focus is on enhancing the setup process by adding detailed instructions for installing essential third-party tools (such as External DNS and Cluster Issuer), clarifying variable usage, and correcting minor errors and typos. The changes also improve the structure and clarity of the documentation, making it easier to follow.

Enhancements to AKS Cluster Setup Instructions:

  • Added comprehensive sections for installing External DNS, Cluster Issuer, and creating a default certificate, including detailed helm commands and configuration examples. Also added guidance on ingress controllers and storage classes. [1] [2]
  • Expanded the Docker usage instructions to include how to run the container interactively and mount local directories, with notes about environment variable persistence.
  • Introduced new domain-related environment variables for more flexible and explicit configuration of DNS and ingress.

Documentation Corrections and Clarifications:

  • Fixed typos and improved grammar throughout the setup and control plane docs (e.g., "prvisioned" to "provisioned", "vriables" to "variables", clarified AKS cluster creation references). [1] [2] [3] [4] [5] [6] [7] [8] [9]
  • Improved explanations for the purpose of installed tools (e.g., cert-manager, external-dns) and the reasoning behind certain setup steps.

Table of Contents and Structure Updates:

  • Updated the Table of Contents in both cluster setup and control plane docs to reflect the new sections and improved organization. [1] [2]

Variable and Configuration Consistency:

  • Clarified the use of environment variables for domains, DNS resource groups, and ingress classes to ensure consistency across the documentation. [1] [2] [3]

These changes collectively make the AKS workshop documentation more robust, user-friendly, and suitable for onboarding new users or teams.


References:
[1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16]

@nashtapu-tibco nashtapu-tibco self-assigned this Nov 7, 2025
@nashtapu-tibco nashtapu-tibco added bug Something isn't working documentation Improvements or additions to documentation labels Nov 7, 2025
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This pull request enhances the Azure Red Hat OpenShift (ARO) and Azure Kubernetes Service (AKS) workshop documentation by improving setup instructions, correcting errors, and adding comprehensive guidance for installing third-party tools and configuring clusters for TIBCO® Control Plane and Data Plane deployments.

Key changes include:

  • Added detailed instructions for installing External DNS, Cluster Issuer, and creating default certificates with helm commands and configuration examples
  • Reorganized documentation structure with updated Table of Contents to improve navigation
  • Fixed spelling errors and improved grammar throughout (e.g., "prvisioned" → "provisioned", "vriables" → "variables")

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
docs/workshop/aro (Azure Red Hat OpenShift)/data-plane/README.md Expanded Elasticsearch deployment instructions, added Prometheus monitoring configuration, corrected typos, and clarified variable usage
docs/workshop/aro (Azure Red Hat OpenShift)/control-plane/README.md Fixed spelling errors in variable references and improved table formatting for network CIDR information
docs/workshop/aro (Azure Red Hat OpenShift)/cluster-setup/README.md Added Docker usage instructions, corrected TOC anchor reference, fixed typos, and enhanced Security Context Constraints documentation
docs/workshop/aks/data-plane/README.md Restructured ingress controller sections, added Kong configuration for user-apps domain, expanded Elasticsearch verification steps, and improved variable organization
docs/workshop/aks/control-plane/README.md Simplified setup by removing redundant External DNS section, improved grammar, and clarified configuration steps
docs/workshop/aks/cluster-setup/README.md Added comprehensive sections for External DNS, Cluster Issuer, and certificate creation with detailed installation commands

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@nashtapu-tibco nashtapu-tibco merged commit 268a5d0 into main Nov 7, 2025
1 check passed
@nashtapu-tibco nashtapu-tibco deleted the update_aro_aks_docs branch November 7, 2025 20:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants