Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

FlexDeploy provides another approach called Partial Deployment.  Its called Partial Deployment because it provides building a "partial" subset of the project and assembling the source into what is called a package.  For example, you may have one project for the entire custom top, but create packages for several sets of changes you are developing for a release.  Developers can build and deploy the packages independently, or group them together in into a release for a shared delivery milestone. 

To enable this capablitycapability, FlexDeploy generates metadata about all of the customizations for your project (called project files), and builds a "catalog".  The developers then build packages using items from this catalog.  We will see this in action as we work through the next two sections of the tutorial.

...

  • Folders may contain folders or applications
  • Applications my may contain projects

Here we will create a folder and an application to hold our project.

...

Click OK to create the new project.  The project is opened for you in the center pane.  Click on the  Configuration tab.  Enter the following values for the required values:

Field
Description
General Project Configuration
SCM TypeThe Source Control Management System type where the project's source is located
Build Workflow


Build WorkflowThe workflow which will be used to build this project
Build InstanceThe topology instance which the build workflow will execute on
Deploy Workflow


Deploy WorkflowThe workflow which will be used to deploy this project
Deploy Instance(s)The topology instance(s) which the deploy workflow will execute on.  If more than one is selected, the user will select specific ones in the deployment request.
SCM Configuration


Info

These properties are dependent on the selected SCM Type.  Properties listed below are for Git.


Git InstanceThe Git instance (repository) from topology which hosts the source for this project
Branch Name ScriptA groovy script which resolves to the branch name to execute the build on.  This is typically the stream selected during build.
Sparse Checkout Folders ScriptA groovy script which resolves to the path (relative to the repository root) containing the root of the source files within the selected Git instance. 
Streams
Stream NameThe name of the Git branch.  If you will be building from multiple branches, you will add a new stream for each.  The stream is selected during the build request, and will available as StreamName variable to the groovy scripts in the SCM Configuration.

Click Save to apply your changes.

...

The next step is to populate the customization files which are stored in our GitHub repository into our FlexDeploy project.  FlexDeploy will interrogate the files, determine the type, and generate metadata about them.  The metadata includes the location on the server where it will be deployed, a generated command used to deploy it, and other attributes specific to the type.  Click on the  Project Files tab to see a list of customization files for this project.  Since its it's a brand - new project, there are not yet any files yet.  

Click the Populate from GIT button, and select master as the Stream.  Click Populate.

...

Tip
titleMetadata Tips

Each type has metadata fields which are used to calculate the deploy command.  With the necessary privileges, you can adjust the metadata and re-evaluate the commands.  However, the preferred approach is to adjust the project properties such that the commands are generated correctly and no manually intervention is required in the majority of cases.  For a deeper understanding of the metadata for each object type, and the role the project properties play in its generation, see EBS Object Types Reference.

For some object types, such as AOLs, you will notice the Build Command.  This is used when you are sourcing the objects from an EBS Development environment rather than an SCM.  In this case, the object will be downloaded from the EBS instance during the build using the build command.  In such cases, you can build the metadata for these objects using FlexDeploy's metadata generator (out of scope for this tutorial).


Notice the project files have a red + icon in the State column.  This indicates that the file is newly populated and the metadata has not yet been saved in FlexDeploy.  After review, click the Save button to persist the metadata.

...