Skip to content

Latest commit

 

History

History
290 lines (182 loc) · 5.6 KB

FAQ.md

File metadata and controls

290 lines (182 loc) · 5.6 KB

FAQ

Common questions about rapid-eks.

General

What is rapid-eks?

A CLI tool that deploys production-ready AWS EKS clusters in 10-15 minutes.

Is it really free?

Yes. 100% open source (MIT License). No subscriptions, no paywalls.

How is it different from eksctl?

eksctl:

  • Official AWS tool
  • More features
  • More complex

rapid-eks:

  • Opinionated (best practices built-in)
  • Faster setup
  • Includes monitoring by default

Both are great. rapid-eks is simpler for common use cases.

What does "production-ready" mean?

  • Multi-AZ for high availability
  • OIDC provider for IRSA
  • Managed nodegroups with autoscaling
  • Monitoring (Prometheus + Grafana)
  • Security best practices

Installation

How do I install it?

pip install git+https://github.com/jtaylortech/rapid-eks.git

What are the prerequisites?

  • Python 3.11+
  • AWS credentials configured
  • Terraform installed
  • kubectl installed (for validation)
  • helm installed (for addons)

Can I install from PyPI?

Not yet. Coming soon after more testing.

Usage

How long does deployment take?

10-15 minutes typically. Validated at 13 minutes.

How much does it cost?

Minimal cluster: ~$240/month

  • EKS control plane: $73
  • 2x t3.medium: $60
  • 3x NAT gateways: $96
  • Data transfer + EBS: $11

Can I customize the configuration?

Yes. Create a YAML config file. See CONFIGURATION.md.

Can I use existing VPC?

Not yet. Coming in v0.2.0.

Can I deploy to GovCloud?

Not yet. Coming in v0.3.0.

How do I destroy a cluster?

rapid-eks destroy my-cluster --auto-approve

Takes 15-20 minutes.

What if destroy fails?

Check TROUBLESHOOTING.md for manual cleanup steps.

Technical

What backend does it use?

Terraform (default). CDK support coming in v0.2.0.

Where is state stored?

Locally in .rapid-eks/ directory. Remote state support coming soon.

Can I inspect the generated code?

Yes. Check .rapid-eks/terraform/ for Terraform code.

Can I modify the generated code?

Yes, but changes will be overwritten on next deployment. Better to customize via config.

What Kubernetes version?

Latest stable (currently 1.31). Configurable in YAML.

What addons are included?

  • Prometheus + Grafana (monitoring)
  • Karpenter (node autoscaling)
  • AWS Load Balancer Controller

See ADDONS.md for details.

How do I add custom addons?

Modify rapid_eks/addons/manager.py or install manually with Helm after deployment.

Is IRSA configured?

Yes. Automatically configured for all addons.

What about security?

  • KMS encryption enabled by default
  • OIDC provider for IRSA
  • Security groups follow AWS best practices
  • No hardcoded credentials

Troubleshooting

Deployment failed. What now?

  1. Check error message
  2. See TROUBLESHOOTING.md
  3. Open GitHub issue if not resolved

Can I retry a failed deployment?

Yes. Fix the issue and run the same command again.

How do I get Grafana password?

Displayed after deployment. Or retrieve from Kubernetes:

kubectl get secret -n monitoring prometheus-grafana \
  -o jsonpath="{.data.admin-password}" | base64 -d

Nodes not ready?

Wait 5 minutes. If still not ready, check:

kubectl describe node <node-name>

Pods not starting?

Check pod status:

kubectl get pods -A
kubectl describe pod -n <namespace> <pod-name>

Contributing

How can I contribute?

See CONTRIBUTING.md.

What features are planned?

See GitHub Issues for roadmap.

Can I request a feature?

Yes! Open a GitHub issue.

How do I report a bug?

Open a GitHub issue with:

  • rapid-eks version
  • AWS region
  • Error message
  • Steps to reproduce

Support

Is there paid support?

Yes. Implementation services, custom features, training available.

Contact: jtaylortechnologies@gmail.com

Where do I get help?

  1. Check documentation
  2. Search GitHub Issues
  3. Open new GitHub Issue
  4. Email for consulting

Can I use this in production?

Yes, but test thoroughly first. Currently v0.1.0 (stable but new).

What's the SLA?

None. This is open source software. For SLA, contact for paid support.

Comparison

rapid-eks vs eksctl

Feature rapid-eks eksctl
Setup time 10-15 min 15-20 min
Monitoring Included Manual
Opinionated Yes No
Complexity Low Medium
Features Core Extensive

rapid-eks vs Terraform modules

Feature rapid-eks Terraform
Setup time 10-15 min 1-2 hours
Learning curve Low Medium
Flexibility Medium High
Maintenance Automated Manual

rapid-eks vs AWS Console

Feature rapid-eks Console
Setup time 10-15 min 2-4 weeks
Reproducible Yes No
Best practices Built-in Manual
Automation Full None

Roadmap

v0.2.0 (Weeks 2-4)

  • CDK backend
  • Remote state management
  • Additional addons

v0.3.0 (Weeks 5-8)

  • GovCloud support
  • FIPS compliance
  • Private ECR

v1.0.0 (Weeks 9-12)

  • Production hardening
  • Multi-cluster management
  • GitOps integration

License

What license is it?

MIT License. Very permissive.

Can I use it commercially?

Yes. No restrictions.

Can I modify it?

Yes. Fork it, modify it, redistribute it.

Do I need to credit you?

Not required, but appreciated!

Contact

Questions? jtaylortechnologies@gmail.com
GitHub: https://github.com/jtaylortech/rapid-eks
Issues: https://github.com/jtaylortech/rapid-eks/issues