-
Notifications
You must be signed in to change notification settings - Fork 98
Add docs for IP address allow list #2825
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.
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
Merged
Merged
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
e3fadba
Add docs for IP address allow list
adrianparker 6114dbf
Update src/pages/docs/octopus-cloud/ip-address-allow-list.md
adrianparker e9eb215
Update src/pages/docs/octopus-cloud/ip-address-allow-list.md
adrianparker c9705f5
Update src/pages/docs/octopus-cloud/ip-address-allow-list.md
adrianparker f7600cb
Update src/pages/docs/octopus-cloud/ip-address-allow-list.md
adrianparker e82bfee
Update src/pages/docs/octopus-cloud/ip-address-allow-list.md
adrianparker 45ba665
Update src/pages/docs/octopus-cloud/ip-address-allow-list.md
adrianparker d771677
Update src/pages/docs/octopus-cloud/ip-address-allow-list.md
adrianparker 5195c9b
Merge branch 'main' into main
adrianparker File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,84 @@ | ||
--- | ||
layout: src/layouts/Default.astro | ||
pubDate: 2025-09-22 | ||
modDate: 2025-09-22 | ||
title: IP address allow list | ||
navOrder: 68 | ||
description: How to configure and enjoy the security benefits of IP address allow lists in Octopus Cloud | ||
--- | ||
|
||
Customers may restrict the IP addresses that can initiate traffic with their Octopus Cloud. | ||
|
||
IP address allow listing provides you with an effective tool to enforce internal access policies and add another layer of protection against some forms of cyber attack. | ||
When activated, only traffic from the IPv4 address ranges you configure, or from sources required by Octopus Deploy, will be allowed to connect to your Octopus Cloud instance. | ||
|
||
## Configuration | ||
|
||
IP address allow list is configured in [Control Center](https://billing.octopus.com/). Users with ```Cloud Subscription Owner``` role can administer the feature from the **Configuration** menu. | ||
|
||
:::div{.hint} | ||
Changes to IP address allow list content or activation status can take up to 60 seconds to apply. | ||
::: | ||
|
||
### Activation | ||
|
||
To enforce traffic restrictions, your allow list must be activated. You can activate your IP address allow list by clicking the **Activate** link. IP address allow listing can only be activated when at least one IP address or range is listed. | ||
|
||
### Deactivation | ||
|
||
You can deactivate IP address allow listing by clicking the **Deactivate** link. Deactivating the feature will not modify your IP address allow list content. | ||
|
||
### Adding an IP address or range | ||
|
||
You can add an IPv4 address or range by clicking **Add a new IP address or range**. This will show a modal dialog which accepts a mandatory IP address or range in CIDR format, and an optional description. If the IP address or range provided already appears on your allow list, the description will be updated to this latest value, or removed if no description is provided. | ||
|
||
### Updating or deleting IP addresses or ranges | ||
|
||
When an IP address or range has been added to the allow list, it can be updated or deleted by clicking the **Edit** or **Delete** links on the relevant row. | ||
|
||
### CSV import | ||
|
||
You can import a CSV file of IP addresses or ranges, with optional descriptions, by selecting **Import a CSV file**. The CSV file must have a header row with two fields in this order, named: **ip_address** and **description**. If any IP address or range provided in the CSV file already appears on your allow list, the description will be updated to the value specified in the file, or removed if no description is provided. | ||
|
||
## Dynamic workers | ||
|
||
Dynamic workers leased by your Octopus Cloud are not protected by your IP address allow list. | ||
|
||
If you require a dynamic worker to have access to your Octopus Cloud instance when IP address allow list is activated, you need to include the IP address used for egress from the dynamic worker in your allow list. | ||
|
||
You can determine the egress IP address of a dynamic worker by running a script on it like ```curl -s https://api.ipify.org```. | ||
adrianparker marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
Please note: | ||
|
||
- Dynamic workers do not have static IP addresses | ||
- You may need to adjust your allow list if a dynamic worker's IP address changes | ||
- Dynamic workers in your Octopus Cloud Azure region can be leased by any customer in that region | ||
|
||
## Azure Private Links | ||
|
||
Customers with Azure Private Link access to their Octopus Cloud can have IP address allow list enabled with zero public IP addresses allowed by contacting [our support team](mailto:support@octopus.com). The combination of Azure Private Links and IP address allow list allows customers to achieve the highest standard of privacy available for Octopus Cloud. | ||
|
||
## Exclusions | ||
|
||
When activated, the IP addresses or ranges specified on your allow list retain access to your Octopus Cloud. | ||
|
||
In addition, access is retained for the IPs and services that: | ||
|
||
- Octopus Cloud requires for successful function | ||
- Octopus Deploy requires to perform our maintenance | ||
- Our Support staff use for access to your instance when needed | ||
|
||
These API endpoints retain public access in order to correctly function: | ||
|
||
- ```/.well-known``` | ||
adrianparker marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
- ```/api/serverstatus/health``` | ||
adrianparker marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
- ```/api/serverstatus/hosted/external``` | ||
adrianparker marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
- ```/token/v1``` | ||
adrianparker marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
Polling tentacle access is not restricted by an activated IP address allow list. | ||
|
||
## Troubleshooting | ||
|
||
If you suspect an activated IP address allow list is causing access issues, consider deactivating the feature, waiting 60 seconds, then testing if the access issue is now resolved. If the issue persists beyond 60 seconds, it is likely unrelated to IP address allow list. If the issue is resolved when your allow list is deactivated, consider if additional IP addresses are required on your allow list. | ||
|
||
If this approach has not resolved the issue, please contact [our support team](mailto:support@octopus.com) for further assistance. | ||
adrianparker marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.