aws / copilot-cli

The AWS Copilot CLI is a tool for developers to build, release and operate production ready containerized applications on AWS App Runner or Amazon ECS on AWS Fargate.
https://aws.github.io/copilot-cli/
Apache License 2.0
3.49k stars 406 forks source link

[Doc Request]: Clarifications on Services management and limitations #5933

Open asb-realrev opened 1 month ago

asb-realrev commented 1 month ago

Describe your idea/feature/enhancement

Seeking guidance and updates to documentation to clarify the following (tried searching multiple times through the docs, aws, github issues and discussions, web): (1) Can a service that was created previously be renamed? What are the problems, blockers from just manually changing the directory/manifest references? (2) If already a manifest and other files exist from some other repo for a service, would one be able to manually copy those files into a similar directory as a new service and skip the copilot svc init command, but instead just use the copilot svc deploy?

Proposal

Add details and guidance into the documentation of services with either a Troubleshooting, FAQ and/or new page sections addressing these types of questions, with warnings of the types of failures/errors that may happen if attempted.

Additional Details

Lou1415926 commented 1 month ago

@asb-realrev thanks for the suggestions! I agree that an FAQ/Troubleshooting page would be really helpful, especially with links to GitHub issues.

Just in case you still need answers for the clarification questions (and in case someone else stumbles into this):

(1) Can a service that was created previously be renamed? What are the problems, blockers from just manually changing the directory/manifest references?

No, you can't rename a service. Changing the directory name or manifest name field would both result in error, that luckily happens early before any deployment is made.

(2) If already a manifest and other files exist from some other repo for a service, would one be able to manually copy those files into a similar directory as a new service and skip the copilot svc init command, but instead just use the copilot svc deploy?

Yes, you should be able to do that.

Hope this helps!