Skip to content

[docs-agent] Fix stale future enhancements, document --no-wait flag, fix build path #110

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.

Sign up for GitHub

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

Open
redhat-chai-bot wants to merge 1 commit into
base: main
Choose a base branch
from
+74 −73
Open

[docs-agent] Fix stale future enhancements, document --no-wait flag, fix build path #110

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
132 changes: 68 additions & 64 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,22 +125,22 @@ rosactl cluster create my-cluster --region us-east-1 --payload my-cluster.json
rosactl cluster create my-cluster --region us-east-1 --payload my-cluster.json --placement mgmt-cluster-01
```

| Flag | Default | Description |
|---|---|---|
| `--region` | `us-east-1` | AWS region |
| `--dry-run` | `false` | Generate config only, do not submit |
| `--output-file` | | Output file for config (defaults to `<name>-cluster.json` in dry-run) |
| `--payload` | | JSON payload file to POST (mutually exclusive with `--dry-run`) |
| `--placement` | | Management cluster name |
| `--version` | `4.22` | OpenShift version |
| `--compute-replicas` | `3` | Number of compute replicas |
| `--compute-machine-type` | `m5.xlarge` | EC2 instance type for compute |
| `--multi-az` | `true` | Multi-AZ deployment |
| `--provider` | `aws` | Cloud provider |
| `--target-project-id` | | Target project ID |
| `--label-environment` | `dev` | Environment label |
| `--label-team` | `platform` | Team label |
| `--output` | | Output format (`json`) |
| Flag | Default | Description |
| ------------------------ | ----------- | --------------------------------------------------------------------- |
| `--region` | `us-east-1` | AWS region |
| `--dry-run` | `false` | Generate config only, do not submit |
| `--output-file` | | Output file for config (defaults to `<name>-cluster.json` in dry-run) |
| `--payload` | | JSON payload file to POST (mutually exclusive with `--dry-run`) |
| `--placement` | | Management cluster name |
| `--version` | `4.22` | OpenShift version |
| `--compute-replicas` | `3` | Number of compute replicas |
| `--compute-machine-type` | `m5.xlarge` | EC2 instance type for compute |
| `--multi-az` | `true` | Multi-AZ deployment |
| `--provider` | `aws` | Cloud provider |
| `--target-project-id` | | Target project ID |
| `--label-environment` | `dev` | Environment label |
| `--label-team` | `platform` | Team label |
| `--output` | | Output format (`json`) |

#### list

Expand All @@ -150,12 +150,12 @@ rosactl cluster list --status Ready --limit 10
rosactl cluster list --output json
```

| Flag | Default | Description |
|---|---|---|
| `--limit` | `50` | Max clusters to return (1-100) |
| `--offset` | `0` | Number of clusters to skip |
| `--status` | | Filter: Pending, Progressing, Ready, Failed |
| `-o`, `--output` | `table` | Output format: `table` or `json` |
| Flag | Default | Description |
| ---------------- | ------- | ------------------------------------------- |
| `--limit` | `50` | Max clusters to return (1-100) |
| `--offset` | `0` | Number of clusters to skip |
| `--status` | | Filter: Pending, Progressing, Ready, Failed |
| `-o`, `--output` | `table` | Output format: `table` or `json` |

#### kubeconfig

Expand Down Expand Up @@ -189,14 +189,15 @@ rosactl cluster-vpc create my-cluster \
--single-nat-gateway=false
```

| Flag | Default | Description |
|---|---|---|
| `--region` | | AWS region (required) |
| `--vpc-cidr` | `10.0.0.0/16` | VPC CIDR block |
| `--public-subnet-cidrs` | `10.0.101.0/24,10.0.102.0/24,10.0.103.0/24` | Public subnet CIDRs |
| `--private-subnet-cidrs` | `10.0.0.0/19,10.0.32.0/19,10.0.64.0/19` | Private subnet CIDRs |
| `--availability-zones` | | AZ names, e.g. `us-east-1a,us-east-1b` (auto-detected if empty) |
| `--single-nat-gateway` | `true` | Single NAT gateway (cost savings) vs per-AZ (HA) |
| Flag | Default | Description |
| ------------------------ | ------------------------------------------- | ------------------------------------------------------------------ |
| `--region` | | AWS region (required) |
| `--vpc-cidr` | `10.0.0.0/16` | VPC CIDR block |
| `--public-subnet-cidrs` | `10.0.101.0/24,10.0.102.0/24,10.0.103.0/24` | Public subnet CIDRs |
| `--private-subnet-cidrs` | `10.0.0.0/19,10.0.32.0/19,10.0.64.0/19` | Private subnet CIDRs |
| `--availability-zones` | | AZ names, e.g. `us-east-1a,us-east-1b` (auto-detected if empty) |
| `--single-nat-gateway` | `true` | Single NAT gateway (cost savings) vs per-AZ (HA) |
| `--no-wait` | `false` | Return immediately without waiting for stack operation to complete |

#### list / describe / delete

Expand All @@ -220,10 +221,11 @@ rosactl cluster-iam create my-cluster \
--region us-east-1
```

| Flag | Default | Description |
|---|---|---|
| `--region` | | AWS region (required) |
| `--oidc-issuer-url` | | Also creates OIDC provider if provided |
| Flag | Default | Description |
| ------------------- | ------- | ------------------------------------------------------------------ |
| `--region` | | AWS region (required) |
| `--oidc-issuer-url` | | Also creates OIDC provider if provided |
| `--no-wait` | `false` | Return immediately without waiting for stack operation to complete |

#### list / describe / delete

Expand All @@ -245,11 +247,12 @@ rosactl cluster-oidc create my-cluster \
--region us-east-1
```

| Flag | Default | Description |
|---|---|---|
| `--oidc-issuer-url` | | OIDC issuer URL (required) |
| `--oidc-thumbprint` | | TLS thumbprint (auto-fetched if omitted) |
| `--region` | | AWS region (required) |
| Flag | Default | Description |
| ------------------- | ------- | ------------------------------------------------------------------ |
| `--oidc-issuer-url` | | OIDC issuer URL (required) |
| `--oidc-thumbprint` | | TLS thumbprint (auto-fetched if omitted) |
| `--region` | | AWS region (required) |
| `--no-wait` | `false` | Return immediately without waiting for stack operation to complete |

Creates a CloudFormation stack (`rosa-{name}-oidc`) and updates the IAM roles stack trust policies.

Expand All @@ -275,15 +278,15 @@ rosactl nodepool create my-np \
--region us-east-1
```

| Flag | Default | Description |
|---|---|---|
| `--cluster-id` | | Cluster ID (required) |
| `--replicas` | `2` | Number of worker replicas |
| `--instance-type` | `m6a.xlarge` | EC2 instance type |
| `--subnet-id` | | Subnet ID (auto-discovered from cluster if omitted) |
| `--instance-profile` | | IAM instance profile (auto-discovered if omitted) |
| `--security-groups` | | Security group IDs (auto-discovered if omitted) |
| `-o`, `--output` | | Output format (`json`) |
| Flag | Default | Description |
| -------------------- | ------------ | --------------------------------------------------- |
| `--cluster-id` | | Cluster ID (required) |
| `--replicas` | `2` | Number of worker replicas |
| `--instance-type` | `m6a.xlarge` | EC2 instance type |
| `--subnet-id` | | Subnet ID (auto-discovered from cluster if omitted) |
| `--instance-profile` | | IAM instance profile (auto-discovered if omitted) |
| `--security-groups` | | Security group IDs (auto-discovered if omitted) |
| `-o`, `--output` | | Output format (`json`) |

#### list

Expand All @@ -292,11 +295,11 @@ rosactl nodepool list --cluster-id <cluster-id>
rosactl nodepool list --cluster-id <cluster-id> --output json
```

| Flag | Default | Description |
|---|---|---|
| `--cluster-id` | | Cluster ID (required) |
| `--limit` | `50` | Max results (1-100) |
| `--offset` | `0` | Number to skip |
| Flag | Default | Description |
| ---------------- | ------- | -------------------------------- |
| `--cluster-id` | | Cluster ID (required) |
| `--limit` | `50` | Max results (1-100) |
| `--offset` | `0` | Number to skip |
| `-o`, `--output` | `table` | Output format: `table` or `json` |

#### delete
Expand All @@ -322,12 +325,13 @@ rosactl bootstrap status --region us-east-1
rosactl bootstrap delete --region us-east-1
```

| Flag | Default | Description |
|---|---|---|
| `--image-uri` | | ECR container image URI (required for create) |
| `--function-name` | `rosa-regional-platform-lambda` | Lambda function name |
| `--stack-name` | `rosa-regional-platform-lambda` | CloudFormation stack name |
| `--region` | | AWS region (required) |
| Flag | Default | Description |
| ----------------- | ------------------------------- | ------------------------------------------------------------------ |
| `--image-uri` | | ECR container image URI (required for create) |
| `--function-name` | `rosa-regional-platform-lambda` | Lambda function name |
| `--stack-name` | `rosa-regional-platform-lambda` | CloudFormation stack name |
| `--region` | | AWS region (required) |
| `--no-wait` | `false` | Return immediately without waiting for stack operation to complete |

The Lambda accepts JSON event payloads with an `action` field: `apply-cluster-vpc`, `delete-cluster-vpc`, `apply-cluster-iam`, `delete-cluster-iam`.

Expand All @@ -341,11 +345,11 @@ rosactl version

### Naming Convention

| Stack | Name |
|---|---|
| VPC | `rosa-{cluster-name}-vpc` |
| IAM | `rosa-{cluster-name}-iam` |
| OIDC | `rosa-{cluster-name}-oidc` |
| Stack | Name |
| ----- | -------------------------- |
| VPC | `rosa-{cluster-name}-vpc` |
| IAM | `rosa-{cluster-name}-iam` |
| OIDC | `rosa-{cluster-name}-oidc` |

All stacks are tagged with `Cluster`, `ManagedBy: rosactl`, and `red-hat-managed: true`.

Expand Down
13 changes: 5 additions & 8 deletions docs/architecture/ARCHITECTURE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -386,14 +386,11 @@ Users can view:
## Future Enhancements

1. CloudFormation change sets for safer updates before applying
2. Dry-run mode to preview resource changes
3. Multi-region support for replicating resources
4. Stack outputs export to file (JSON/YAML)
5. Template validation with cfn-lint integration
6. Rollback subcommand for failed stacks
7. Parallel stack management (create VPC and IAM concurrently)
8. Verbose logging flag for detailed AWS SDK output
9. Cost estimation before creating resources
2. Multi-region support for replicating resources
3. Template validation with cfn-lint integration
4. Rollback subcommand for failed stacks
5. Parallel stack management (create VPC and IAM concurrently)
6. Cost estimation before creating resources

## References

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/DEVELOPMENT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ go mod download
make build
```

The binary will be available at `./rosactl`.
The binary will be available at `./bin/rosactl`.

@coderabbitai coderabbitai Bot Jul 31, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Update the remaining binary path in the development workflow.

Line 42 correctly documents ./bin/rosactl, but line 81 still runs ./rosactl. After make build, that command fails because the Makefile writes the binary to ./bin.

Proposed fix 
-./rosactl cluster-vpc create test --region us-east-1 --help
+./bin/rosactl cluster-vpc create test --region us-east-1 --help
🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/guides/DEVELOPMENT.md` at line 42, Update the remaining development
workflow command near the documented ./bin/rosactl path to invoke the binary
from ./bin instead of the repository root, keeping the command consistent with
the Makefile output location and the existing documentation.


4. Run tests

Expand Down