add section for --generate-only flag #580
Conversation
| @@ -7,6 +7,8 @@ When you've finished the development work for your Appsody project, you will hav | |||
|
|
|||
| The Appsody CLI provides the [appsody deploy](/docs/cli-commands/#appsody-deploy) command to build and deploy a Docker image directly to a Kubernetes cluster that you are using for testing or staging. | |||
|
|
|||
| Your project must include a deployment manifest called `app-deploy.yaml`, this manifest is generated by default when you run `appsody build` or `appsody deploy`. If you want to quickly obtain the deployment manifest without having to build or deploy your application, run the `appsody deploy --generate-only` command, and then check the `app-deploy.yaml` file into your source code repository. | |||
There was a problem hiding this comment.
The deployment manifest for your project (app-deploy.yaml) is created or updated when you run appsody build or appsody deploy. Appsody CLI uses deployment information from the stack and adds various traceability metadata (ADD LINK) while generating this manifest. Developers can edit this file to suit their application needs and store under source control. You can run the appsody deploy --generate-only command if you want to quickly obtain the deployment manifest without having to build or deploy your application.
There was a problem hiding this comment.
Thanks! I've made these changes with minor tweaks :)
| @@ -7,6 +7,10 @@ When you've finished the development work for your Appsody project, you will hav | |||
|
|
|||
| The Appsody CLI provides the [appsody deploy](/docs/cli-commands/#appsody-deploy) command to build and deploy a Docker image directly to a Kubernetes cluster that you are using for testing or staging. | |||
|
|
|||
| Your project must include a deployment manifest called `app-deploy.yaml`, this manifest is generated by default when you run `appsody build` or `appsody deploy`. If you want to quickly obtain the deployment manifest without having to build or deploy your application, run the `appsody deploy --generate-only` command, and then check the `app-deploy.yaml` file into your source code repository. | |||
There was a problem hiding this comment.
Did you intend to remove the old section? I think the second paragraph covers everything?
Checklist
Description
Added a few sentences for the
--generate-onlyflag to the deploy docRelated Issues
Related to #567