Skip to content
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

add section for --generate-only flag #580

Merged
merged 3 commits into from
Jun 26, 2020
Merged

add section for --generate-only flag #580

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7afb231
add section for --generate-only flag
skoh7645 Jun 26, 2020
c75750b
requested changes
skoh7645 Jun 26, 2020
3ddf8ff
remove paragraph
skoh7645 Jun 26, 2020
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
2 changes: 2 additions & 0 deletions content/docs/using-appsody/deploying.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Contributor

@neeraj-laad neeraj-laad Jun 26, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

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.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Thanks! I've made these changes with minor tweaks :)

Copy link
Contributor

Choose a reason for hiding this comment

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

Did you intend to remove the old section? I think the second paragraph covers everything?


You can delegate the build and deployment steps to an external pipeline, such as a Tekton pipeline that consumes the source code of your Appsody project after you push it to a GitHub repository. Within the pipeline, you can run [appsody build](/docs/using-appsody/building), which builds the application image and generates a deployment manifest. You can use the manifest to deploy your application to a Kubernetes environment where the Appsody operator is installed.

These deployment options are covered in more detail in the following sections.
Expand Down