Octopus Deploy Documentation

Octopus Cloud

Last updated

Octopus Cloud is the hosted version of Octopus Deploy.

We designed Octopus Cloud and self-hosted Octopus to provide the same functionality; however, with Octopus Cloud we're responsible for backups, automatically upgrading the service, and maintaining and monitoring the underlying systems.

You can sign up for Octopus Cloud at octopus.com/free.

Octopus Server

The Octopus Server is the deployment automation server where you define your deployment processes and runbooks and manage the releases of your software.

The Octopus Server includes the Octopus Rest API and the Octopus Web Portal.

Octopus Dashboard

You can use the Octopus REST API or the Octopus Web Portal to design your deployment processes and your releases, connect to the servers, services, and accounts where your software will be deployed, and to use runbooks to automate routine maintenance and emergency operations tasks like infrastructure provisioning, database management, and website failover and restoration.

Create an Octopus account

An Octopus account lets you manage your instances of Octopus Cloud. You can register for you Octopus account at octopus.com/register.

You can register for an account with your existing Google or Microsoft account or create a unique login for Octopus:

  1. Enter your name.
  2. Provide your email address and create a password.
  3. On the next screen, verify your email address.
  4. After your email has been verified, you will be logged into your Octopus account.

Now that you've created an Octopus account, you can create a new instance of Octopus Cloud.

Create a cloud instance

To create a new instance of Octopus Cloud, make sure you are logged into your Octopus account:

  1. Click Create a new cloud instance.
  2. Enter the URL you would like to use to access your instance: <yoururl>.octopus.app. If the URL you selected is not available, enter a different URL.
  3. Select the region where you would like your instance to be hosted.
  4. Add your company name.
  5. Review the terms of our customer agreement, privacy policy, and acceptable usage policy.
  6. Click Agree, deploy my Octopus!.

You will be taken to the account provisioning screen. Your Octopus Cloud instance should be ready within a minute or so. You will receive an email when the instance is ready to use.

When the instance is ready, you will see it (and any other instances you have access to) the next time you log in to your Octopus account at https://octopus.com/signin.

Uploading packages to Octopus Cloud servers

Factors such as geographical distance, network bandwidth, and network congestion may cause package uploads to your Octopus Cloud Server to take longer than expected.

If you are having difficulty uploading packages to your Octopus built-in package feed within the default timeout threshold, typically within 5 minutes, you might be affected by one or more of the factors mentioned above. In this case, you could try increasing the timeout threshold of the Octopus CLI or nuget.exe to a value that suits you. We also recommend using the Octopus CLI, Octopus.Client, or the TeamCity Plugin (v4.41.0+) because they have the advantage of using delta compression.

In the near future, the Octopus Cloud will become available in additional regions and you'll have the ability to move between regions.

Change your password

To change your password for the Octopus instance and Octopus account:

  1. Go to Octopus.com/signin.
  2. Click the drop-down menu next to your username in the top right corner.
  3. Click profile.
  4. Click the Change Password link.
  5. Enter your new password.
  6. Confirm the new password, and click Change password.

Reset the Octopus account password

If you forget your username or password for your Octopus account or Octopus instance, you can reset them via Octopus.com

  1. Visit octopus.com/signin.
  2. Click Forgot your password?
  3. Reset your credentials and log into your Octopus account. You can now launch your Octopus instance from the accounts dashboard.

Invite users to your Octopus Cloud instance

You can add new users to your Octopus Cloud instance from within your Octopus.com account. This feature is being rolled out gradually. If you have access to the invites feature, you will see invites in your instance panel. If you do not have access to this feature and would like access, please contact support.

  1. Log into your account at Octopus.com/signin.
  2. Select Manage on your instance panel.
  3. Click Invite a user, enter their name and email address.
  4. Click Submit.

If the user already has an Octopus ID, they can Sign in to view their newly accessible instance within the correct Organization. Otherwise, they can Register for a new account with the email address the invitation was sent to. All invitees will be set with the Instance User role. Users with the User Instance role will not be able to change any instance account settings or invite other users.

By default, all invitees will be added to the Everyone team within the Octopus instance and will not have any permissions. After they have signed in for the first time, you will need to add them to a team with more permissions.

  1. Go to Configuration
  2. Select Teams
  3. Create or select an existing team such as Space Managers
  4. Select Add Member
  5. Click Add and then Save.

Set the outage window

In order to keep your instance of Octopus Cloud updated and running the latest version, we will occasionally need to take it offline to update the software. You can let us know the best time for this to do this by setting the outage window.

  1. Log in to you Octopus account.
  2. Select your cloud instance.
  3. Click the Change outage window link.
  4. Select the time in UTC, providing a window of at least two hours and click Save outage window.

Log in to your Octopus Cloud instance

You can access your Octopus Cloud instance at the URL you defined during the registration process. Where <yoururl> is the part of the URL you provided:

https://<yoururl>.octopus.app/app#/users/sign-in

Octopus Cloud version

We keep your instance of Octopus Cloud up to date and running the latest version of Octopus Deploy. To check which version your instance is running, log into the Octopus Web Portal, and click the drop-down menu that appears next to your name in the top right corner. The version is displayed at the top of the display.

Learn more

Need support? We're here to help.