Skip to content

Conversation

@sivanel97
Copy link
Contributor

@sivanel97 sivanel97 commented Oct 27, 2025

User description

Description

Fixed the issues raised in the following JIRA issue: https://getport.atlassian.net/browse/PORT-16583

Updated docs pages


PR Type

Documentation, Bug fix


Description

  • Updated Kubernetes Helm installation instructions with clearer steps

  • Replaced generic component with specific portal data sources page link

  • Added visual guide showing helm command location in Port UI

  • Removed outdated region tip reference


Diagram Walkthrough

flowchart LR
  A["Generic Installation Component"] -->|replaced with| B["Specific Portal Instructions"]
  B --> C["Data Sources Page Link"]
  B --> D["Helm Command Copy Instructions"]
  B --> E["UI Screenshot Guide"]
Loading

File Walkthrough

Relevant files
Documentation
kubernetes.md
Clarify Helm installation with portal-specific instructions

docs/build-your-software-catalog/sync-data-to-catalog/kubernetes-stack/kubernetes/kubernetes.md

  • Replaced generic OceanRealtimeInstallation component with explicit
    step-by-step Helm installation instructions
  • Added direct link to Kubernetes data sources page in Port portal
  • Included visual screenshot showing where to find and copy the helm
    command
  • Removed outdated PortApiRegionTip component reference
+6/-2     

@qodo-merge-pro
Copy link
Contributor

qodo-merge-pro bot commented Oct 27, 2025

PR Compliance Guide 🔍

Below is a summary of compliance checks for this PR:

Security Compliance
🟢
No security concerns identified No security vulnerabilities detected by AI analysis. Human verification advised for critical code.
Ticket Compliance
🎫 No ticket provided
  • Create ticket/issue
Codebase Duplication Compliance
Codebase context is not defined

Follow the guide to enable codebase context checks.

Custom Compliance
🟢
Generic: Meaningful Naming and Self-Documenting Code

Objective: Ensure all identifiers clearly express their purpose and intent, making code
self-documenting

Status: Passed

Generic: Secure Error Handling

Objective: To prevent the leakage of sensitive system information through error messages while
providing sufficient detail for internal debugging.

Status: Passed

Generic: Comprehensive Audit Trails

Objective: To create a detailed and reliable record of critical system actions for security analysis
and compliance.

Status:
Non-code change: The PR only updates documentation text and images and does not add or modify application
logic where audit logging would apply.

Referred Code
To install the integration using Helm:

1. Go to the Kubernetes [data sources page](https://app.getport.io/settings/data-sources?section=EXPORTERS&provider=Kubernetes) in your portal.

2. A `helm` command will be displayed, with default values already filled out (e.g. your Port client ID, client secret, etc).  
   Copy the command then run it in your terminal to install the integration.
    <img src="/img/sync-data-to-catalog/kubernetesIntegrationPage.png" width="80%" border='1px' />
Generic: Robust Error Handling and Edge Case Management

Objective: Ensure comprehensive error handling that provides meaningful context and graceful
degradation

Status:
Documentation only: The added changes are instructional documentation and do not introduce executable code
where error handling could be evaluated.

Referred Code
To install the integration using Helm:

1. Go to the Kubernetes [data sources page](https://app.getport.io/settings/data-sources?section=EXPORTERS&provider=Kubernetes) in your portal.

2. A `helm` command will be displayed, with default values already filled out (e.g. your Port client ID, client secret, etc).  
   Copy the command then run it in your terminal to install the integration.
    <img src="/img/sync-data-to-catalog/kubernetesIntegrationPage.png" width="80%" border='1px' />
Generic: Secure Logging Practices

Objective: To ensure logs are useful for debugging and auditing without exposing sensitive
information like PII, PHI, or cardholder data.

Status:
Potential secret mention: The docs mention client ID and client secret being prefilled in the Helm command; while
this is instructional text, no code changes affect logging to assess for exposure.

Referred Code
2. A `helm` command will be displayed, with default values already filled out (e.g. your Port client ID, client secret, etc).  
   Copy the command then run it in your terminal to install the integration.
Generic: Security-First Input Validation and Data Handling

Objective: Ensure all data inputs are validated, sanitized, and handled securely to prevent
vulnerabilities

Status:
Secrets in docs: The documentation references a Helm command containing client ID and client secret values;
although not code, ensure screenshots and examples do not expose real secrets.

Referred Code
2. A `helm` command will be displayed, with default values already filled out (e.g. your Port client ID, client secret, etc).  
   Copy the command then run it in your terminal to install the integration.
    <img src="/img/sync-data-to-catalog/kubernetesIntegrationPage.png" width="80%" border='1px' />
  • Update
Compliance status legend 🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

@qodo-merge-pro
Copy link
Contributor

qodo-merge-pro bot commented Oct 27, 2025

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
General
Use style attribute for image border

Replace the deprecated border attribute on the tag with the style attribute to
ensure the border is rendered correctly and adheres to modern web standards.

docs/build-your-software-catalog/sync-data-to-catalog/kubernetes-stack/kubernetes/kubernetes.md [77]

-<img src="/img/sync-data-to-catalog/kubernetesIntegrationPage.png" width="80%" border='1px' />
+<img src="/img/sync-data-to-catalog/kubernetesIntegrationPage.png" width="80%" style={{border: '1px solid #ccc'}} />
  • Apply / Chat
Suggestion importance[1-10]: 5

__

Why: The suggestion correctly identifies the use of a deprecated border attribute with an invalid value on an <img> tag and proposes the modern, correct approach using the style attribute, improving HTML validity.

Low
  • Update

@aws-amplify-eu-west-1
Copy link

This pull request is automatically being deployed by Amplify Hosting (learn more).

Access this pull request here: https://pr-2952.d2ngvl90zqbob8.amplifyapp.com

@sivanel97 sivanel97 merged commit 1a3a554 into main Oct 30, 2025
5 checks passed
@sivanel97 sivanel97 deleted the PORT-16583-bug-kubernetes-doc-set-up-section-is-outdated-in-spots-and-just-false-in-others branch October 30, 2025 05:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants