Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Custom port exposure, API credentials override in outputs #1339

Merged
merged 11 commits into from
Nov 13, 2024

Conversation

skudasov
Copy link
Collaborator

@skudasov skudasov commented Nov 13, 2024

  • Add custom port exposure in TOML
  • Return default user/password credentials in outputs, so we can connect to any node by overriding TOML params
  • Change clclient.New signature

Below is a summarization created by an LLM (gpt-4-0125-preview). Be mindful of hallucinations and verify accuracy.

Why

The changes enhance the flexibility and security of Chainlink nodes in test environments by allowing custom port configurations and setting default API credentials for node authentication. These adjustments facilitate more dynamic testing setups and secure connections to Chainlink nodes.

What

  • book/src/SUMMARY.md
    • Changed the title from "Components Persistence" to "Exposing Components" for clarity on the section's content.
  • book/src/framework/components/chainlink/node.md and nodeset.md
    • Added documentation for new custom_ports, api_auth_user, and api_auth_password configurations, enabling custom port mappings and default API credentials for Chainlink nodes.
  • book/src/framework/components/external.md
    • Included new fields api_auth_user and api_auth_password in the example TOML configuration to highlight the capability to set default API credentials for external components.
  • book/src/framework/components/state.md
    • Title changed to better reflect the content on exposing component data and ports.
    • Added a new section on custom ports, explaining how to configure them for nodes.
  • book/src/framework/test_configuration_overrides.md
    • Added guidance on overriding component configurations, emphasizing the hierarchy and application of overrides.
  • framework/.changeset/v0.2.4.md
    • Documented the addition of custom port exposure and default API credentials in output configurations, and a change in the clclient.New function signature.
  • framework/clclient/client.go
    • Updated the NewChainlinkClient function to utilize the new output fields for API credentials, removing hardcoded defaults in favor of configurable options.
  • framework/components/clnode/clnode.go
    • Implemented the handling of custom_ports in node configurations and included default API credentials (api_auth_user, api_auth_password) in the node output for secure authentication.
  • framework/components/simple_node_set/node_set.go
    • Modified node set setup to accommodate custom port configurations, ensuring each node in a set can specify its own set of ports.
  • framework/examples/myproject/README.md
    • Added a new "Level 0" section to the Project Maturity Model, outlining initial planning and integration considerations for testing.
  • Various test files in framework/examples/myproject/
    • Replaced NewCLDefaultClients with the updated New function to align with changes in client initialization, reflecting the shift to configurable API credentials.

@skudasov skudasov requested review from sebawo and a team as code owners November 13, 2024 21:11
@skudasov skudasov changed the title Features Custom port exposure, API credentials override in outputs Nov 13, 2024
@cl-sonarqube-production
Copy link

@skudasov skudasov merged commit 984c3e8 into main Nov 13, 2024
47 of 49 checks passed
@skudasov skudasov deleted the update-maturity-model branch November 13, 2024 22:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant