Skip to content

IP ranges updates #9328

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

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

IP ranges updates #9328

wants to merge 5 commits into from

Conversation

rosieyohannan
Copy link
Contributor

@rosieyohannan rosieyohannan commented Apr 7, 2025

Description

  • General tidy up
  • Move all content on IP addresses for core services moved to the end of the page as an add on, to keep all the IP Ranges feature information togehter
  • Remove changelog. The entries exist in the main product changelog

Reasons

The flow of the page was confusing, combining information on the feature "IP Ranges" and also the IP adresses customers can expect core CircleCI services to use. This page is in our top 10 most read so we wanted to make changes to improve readability and structure.

Content Checklist

Please follow our style when contributing to CircleCI docs. Our style guide is here: https://circleci.com/docs/style/style-guide-overview.

Please take a moment to check through the following items when submitting your PR (this is just a guide so will not be relevant for all PRs) 😸:

  • Break up walls of text by adding paragraph breaks.
  • Consider if the content could benefit from more structure, such as lists or tables, to make it easier to consume.
  • Keep the title between 20 and 70 characters.
  • Consider whether the content would benefit from more subsections (h2-h6 headings) to make it easier to consume.
  • Check all headings h1-h6 are in sentence case (only first letter is capitalized).
  • Is there a "Next steps" section at the end of the page giving the reader a clear path to what to read next?
  • Include relevant backlinks to other CircleCI docs/pages.

@rosieyohannan rosieyohannan marked this pull request as ready for review April 15, 2025 10:33
@rosieyohannan rosieyohannan requested review from a team as code owners April 15, 2025 10:33

Use conditional logic to control when IP ranges is enabled with pipeline parameters.
Use conditional logic to control when IP ranges is enabled with pipeline parameters. You can set the pipeline parameter `pipeline.parameters.ip_ranges` to `true` to enable IP ranges for the `build` job. FOr more information on triggering pipelines with pipeline parameters, see the xref:triggers-overview#[Trigger a pipeline] page.
Copy link
Contributor

Choose a reason for hiding this comment

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

In that example, the parameter's name is ip_ranges. The notation pipeline.parameters.ip_ranges is how you refer to the parameter.

Typo: FOr.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Just checking - are you suggesting a change to the paragraph here? I've fixed the FOr typo but from your comment it seems like I need to do something else?

* link:https://ip-ranges.amazonaws.com/ip-ranges.json[AWS]: CircleCI uses the _us-east-1_ and _us-east-2_ regions.
* link:https://www.gstatic.com/ipranges/cloud.json[GCP]: CircleCI uses the _us-east1_ and _us-central1_ regions.

CircleCI _does not recommend_ configuring an IP-based firewall using the AWS or GCP IP addresses. The vast majority are not CircleCI's machines. CircleCI can _not guarantee_ that the addresses in the AWS or GCP endpoints persist from day-to-day, as these addresses are reassigned continuously.
Copy link
Contributor

Choose a reason for hiding this comment

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

Due to the security aspect, I think this paragraph could be a "CAUTION".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants