Octopus Deploy Documentation

Projects

Last updated

Projects let you create and manage your deployment processes, releases, and operations runbooks from the Octopus web portal.

For each project, you can define a deployment process (the steps required to deploy your software), operations runbooks to manage your infrastructure, configuration variables (for example, application settings, database connection strings), the environments where the software will be deployed, and releases of your software.

You can manage your projects by navigating to the Projects tab in the Octopus web portal:

The Projects area of Octopus Deploy

If you have already created projects, or are joining an existing team, you'll see the existing projects on the projects page.

Add a Project

Before you can define your deployment processes or operations runbooks, you must create a project:

  1. Select Projects from the main navigation, and click ADD PROJECT.
  2. Give the project a name.
  3. Click SHOW ADVANCED.
  4. Add a description for the project.
  5. If you want to change the Project group select an existing project group from the dropdown menu.
  6. If you want to change the Lifecycle select an existing lifecycle from the dropdown menu.
  7. Click SHOW LIFECYCLE if you'd like to see a visual representation of the selected lifecycle.
  8. Click SAVE and you will be taken to the newly created project's overview page.

Now that you've created a project, you can define your deployment process or operations runbooks.

Project Settings

You can change the projects settings by accessing the settings menu on the project's main page. The settings you can change are:

Deployment Settings

  • Package Re-deployment
    • Specify to always deploy all packages or to skip any package steps that are already installed.
  • Deployment Targets
    • Specify if deployments are allow if there are no deployment targets.
  • Deployment Target Status
    • Choose to skip unavailable, or exclude unhealthy targets from the deployment.
  • Deployment Changes Template
    • Specify a template for each deployment's changes.
  • Default Failure Mode

Add a logo to make it easily identifiable from the projects page.

  1. From the project's main page, select settings.
  2. Click the Logo section of the settings page.
  3. Click the file selector and select a file to upload.
  4. Click open to upload your logo image, and click Save.

Project Group

Project groups are a way of organizing your projects.

Note, the Default Project group contains all of the projects that have not been added to another group.

Add a Project Group

  1. From the Projects tab, click ADD GROUP.
  2. Give the group a name and description.
  3. Click SAVE.

When the group is first created and doesn't have any projects associated with it, you will need to click SHOW EMPTY GROUPS on the projects page to see the group.

Add Projects to a Group

After you have created a project group there are a number of ways you can add projects to the group:

  • Navigate to the Projects page from the main navigation, find the group you want to add the project to, and click ADD PROJECT.
  • Edit an existing project by navigating to the project, selecting Settings and editing the Project Group.
  • Specify the Project Group under Advanced Settings when you create a new project.

Edit or Delete Project Groups

To edit or delete a project group click the project group’s ... overflow menu and select edit. From there you can edit the groups name or description. If you need to delete the group, click the ... overflow menu again and select Delete.

Project Permissions

For information about project permissions, see managing users and teams.

Clone a Project

Projects can be cloned.

  1. From the project's menu, select settings.
  2. Click the ... overflow menu, and select Clone.
  3. Give the new project you are cloning from the original project a name.
  4. Review the settings for the new project and when you are satisfied, click SAVE.

After you've cloned a project, you can see details about where your project was cloned from and which projects have been cloned from your project, by navigating to the project's overview page and selecting Settings and looking at the Cloning History section.

In This Section

The following topics are explained further in this section:

Welcome! We use cookies and data about how you use our website allow us to improve the website and your experience, and resolve technical errors. Our website uses cookies and shares some of your data with third party analytics companies for these purposes.

If you decline, we will respect your privacy. A single cookie will be used in your browser to remember your preference.