Enhance README and add example Terraform variables #137
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ultiparty sandbox. Updated the README to provide a comprehensive overview of the environment setup, including prerequisites, configuration options, and troubleshooting steps. Introduced a new example `terraform.tfvars` file to guide users in configuring their Kaleido Platform API settings and environment details.
onelapahead
reviewed
Nov 26, 2025
| # IMPORTANT: Use your Kaleido Platform user credentials (NOT Keycloak or K8s secrets) | ||
| # | ||
| # For local K8s with ingress: https://your-hostname.domain | ||
| # For port-forward: https://localhost:5000 |
Contributor
There was a problem hiding this comment.
nit: this is not supported because of the host based routing the platform does
onelapahead
reviewed
Nov 26, 2025
Comment on lines
198
to
206
| ### Certificate Errors | ||
|
|
||
| **Error:** `x509: certificate is not trusted` | ||
|
|
||
| **Solution:** | ||
| ```bash | ||
| export KALEIDO_PLATFORM_INSECURE=true | ||
| terraform apply | ||
| ``` |
Contributor
There was a problem hiding this comment.
Just noting this should only be relevant for software users running the platform locally as per our "Quick Start" guide
onelapahead
reviewed
Nov 26, 2025
Contributor
onelapahead
left a comment
onelapahead
left a comment
There was a problem hiding this comment.
Just requesting minor edits
Comment on lines
181
to
183
| # Step 4: Verify deletion | ||
| kubectl get pods -n default | grep -E "amr-0|bnr-0|kmr-0|pdr-0|inr-0" | ||
| # Should return no results |
Contributor
There was a problem hiding this comment.
These are software-specific details that might confuse our SaaS users - think its best we leave this off for now
Comment on lines
208
to
218
| ### Connection Refused | ||
|
|
||
| **Error:** `connection refused` on localhost | ||
|
|
||
| **Solutions:** | ||
| - ✓ Check port-forward is running: `ps aux | grep port-forward` | ||
| - ✓ Verify service port: `kubectl get svc kaleidoplatform-apigw -n default` | ||
| - ✓ Restart port-forward if needed | ||
| ``` | ||
| kubectl port-forward svc/kaleidoplatform-apigw 5000:5000 -n default | ||
| ``` |
Contributor
There was a problem hiding this comment.
Same here I think we can remove this as our SaaS users won't know what this means
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.