Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ parameters:
default: false

...
# jobs configuration ommitted for brevity
# jobs configuration omitted for brevity

workflows:
build:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//== Command line installation: pre-steps

// Display the following step for machine runner installation only as container runner is not yet avaiable on server
// Display the following step for machine runner installation only as container runner is not yet available on server
ifdef::machine[]
NOTE: If you are installing **self-hosted runners for server**, the CircleCI CLI needs to be configured using your server API key. Run `circleci setup` to configure the CLI and access the option to supply a new API token if required.
endif::[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ The pod will have a status of `OOMKilled` when viewed in Kubernetes with kubectl
[#pod-host-node-is-out-of-disk-space]
=== Pod host node is out of disk space

If the node is full it will have a `node.kuberenetes.io/disk-pressure` taint, which will prevent new task pods from being scheduled. If all valid nodes for the pod have the same taint, or other conditions that prevent scheduling, the task pod will sit in a pending state until an untainted valid node becomes available. This will show the job as stuck in the **Preparing Environment** step in the UI.
If the node is full it will have a `node.kubernetes.io/disk-pressure` taint, which will prevent new task pods from being scheduled. If all valid nodes for the pod have the same taint, or other conditions that prevent scheduling, the task pod will sit in a pending state until an untainted valid node becomes available. This will show the job as stuck in the **Preparing Environment** step in the UI.

You need to scale your cluster more effectively to avoid this state.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ In the following example, if the `build-job` passes and the current branch is `m
version: 2.1

jobs:
# build job ommitted for brevity
# build job omitted for brevity
deploy-job:
docker:
- image: <docker-image-name-tag>
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/modules/deploy/pages/deploy-to-heroku.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ jobs:
- image: <docker-image-name-tag>
steps:
- checkout
# Additional steps ommitted for brevity
# Additional steps omitted for brevity
deploy:
docker:
- image: <docker-image-name-tag>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ A `github` organization is created when you log in to CircleCI using your _socia

. Navigate to your link:https://app.circleci.com/settings/user[User settings] page.
. Select the **Account Integrations** from the sidebar.
. At the bottom of the page, select the link that reads `Recieved instructions from the CircleCI Support team to authorize a GitHub OAuth app?`.
. At the bottom of the page, select the link that reads `Received instructions from the CircleCI Support team to authorize a GitHub OAuth app?`.
. Follow the instructions to create a `github` organization.

Once your `github` organization is created you can start setting up and following projects:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ To access a job's build environment for troubleshooting, rerun the job with SSH
image:guides:ROOT:getting-started-guide-exp/validate-config.png[float=right]
[%hardbreaks]
*VS Code extension*
Using the xref:toolkit:vs-code-extension-overview.adoc[CircleCI VS Code extention], validate your CircleCI config file. Get help with troubleshooting config updates and help keeping dependencies up to date.
Using the xref:toolkit:vs-code-extension-overview.adoc[CircleCI VS Code extension], validate your CircleCI config file. Get help with troubleshooting config updates and help keeping dependencies up to date.

{empty} +

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/modules/optimize/pages/optimizations.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ NOTE: Open a link:https://support.circleci.com/hc/en-us/requests/new[Support tic

* Read more about resource classes on the xref:execution-managed:resource-class-overview.adoc[resource class overview] page.

[#configuraiton]
[#configuration]
== Optimize your configuration files

[#dynamic-configuration]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= Controlling serial execution across your organization
:page-platform: Cloud, Server v4.9+
:page-description: An overview of controlloing serial execution accross a CircleCI org.
:page-description: An overview of controlling serial execution across a CircleCI org.
:experimental:

Serial groups enable controlled, sequential execution of CircleCI jobs across your organization to prevent conflicts when multiple jobs need to access shared resources or when operation order is critical.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ For `circleci` type organizations, projects are created directly in CircleCI via

=== Organization integration

The organizaiton integration options available to you depend on your organization type. By _integration_ here we mean the way CircleCI checks out your code from your VCS provider. Options are as follows:
The organization integration options available to you depend on your organization type. By _integration_ here we mean the way CircleCI checks out your code from your VCS provider. Options are as follows:

[.table-scroll]
--
Expand Down Expand Up @@ -187,7 +187,7 @@ The following limits are currently in place for the Free Plan:
- Each user can create up to three `circleci` organizations on the Free Plan.
- Each `circleci` organization under a Free Plan can have up to 10 projects.

If you need more organizations or projects, consider upgrading to a Paid Plan or link:https://support.circleci.com/hc/en-us/requests/new[contact our Support team]. See hte xref:plans-pricing:plan-overview.adoc[Plan Overview] page for more information.
If you need more organizations or projects, consider upgrading to a Paid Plan or link:https://support.circleci.com/hc/en-us/requests/new[contact our Support team]. See the xref:plans-pricing:plan-overview.adoc[Plan Overview] page for more information.

== Quickstart

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/modules/security/pages/contexts.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ NOTE: If a _deleted_ context is used in a job, the job will fail and show an err
[#security-group-restrictions]
== Security group restrictions

NOTE: Restricting the use of contexts using security groups is available for `github` type organizations only. Form more infomation on organization types, see the xref:permissions-authentication:users-organizations-and-integrations-guide.adoc#organizations[Users, Organizations, and Integrations Guide].
NOTE: Restricting the use of contexts using security groups is available for `github` type organizations only. For more information on organization types, see the xref:permissions-authentication:users-organizations-and-integrations-guide.adoc#organizations[Users, Organizations, and Integrations Guide].

A context security setting is available for `github` type organizations to require all newly-created contexts in the organization to be group-restricted. Contexts can still be created, but an administrator must assign at least one security group before the context will be available for use in workflows. This setting can be found in menu:Organization Settings[Security].

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3091,7 +3091,7 @@ parameters:
default: false

...
# jobs configuration ommitted for brevity
# jobs configuration omitted for brevity

workflows:
build:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
:toc: macro
:toc-title:

// This doc uses ifdef and ifndef directives to display or hide content specific to Google Cloud Storage (env-gcp) and AWS (env-aws). Currently, this affects only the generated PDFs. To ensure compatability with the Jekyll version, the directives test for logical opposites. For example, if the attribute is NOT env-aws, display this content. For more information, see https://docs.asciidoctor.org/asciidoc/latest/directives/ifdef-ifndef/.
// This doc uses ifdef and ifndef directives to display or hide content specific to Google Cloud Storage (env-gcp) and AWS (env-aws). Currently, this affects only the generated PDFs. To ensure compatibility with the Jekyll version, the directives test for logical opposites. For example, if the attribute is NOT env-aws, display this content. For more information, see https://docs.asciidoctor.org/asciidoc/latest/directives/ifdef-ifndef/.

CircleCI server v4.2 is installed as a Helm chart. The installation process is broken down into four phases. There is a validation step at the end of each phase, allowing you to confirm success before moving to the next phase. Depending on your requirements, phases 3 and 4 may include multiple steps. This installation guide assumes you have already read the xref:overview:circleci-server-overview.adoc[CircleCI server v4.2 overview].

Expand Down Expand Up @@ -132,7 +132,7 @@ For high availability, and to avoid potential outages, you should provision subn
|===
--

[#minimum-permissions-requirments]
[#minimum-permissions-requirements]
=== Minimum permissions requirements

The installing user must have **at least** admin permissions for the namespace into which CircleCI is to be installed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
:toc: macro
:toc-title:

// This doc uses ifdef and ifndef directives to display or hide content specific to Google Cloud Storage (env-gcp) and AWS (env-aws). Currently, this affects only the generated PDFs. To ensure compatability with the Jekyll version, the directives test for logical opposites. For example, if the attribute is NOT env-aws, display this content. For more information, see https://docs.asciidoctor.org/asciidoc/latest/directives/ifdef-ifndef/.
// This doc uses ifdef and ifndef directives to display or hide content specific to Google Cloud Storage (env-gcp) and AWS (env-aws). Currently, this affects only the generated PDFs. To ensure compatibility with the Jekyll version, the directives test for logical opposites. For example, if the attribute is NOT env-aws, display this content. For more information, see https://docs.asciidoctor.org/asciidoc/latest/directives/ifdef-ifndef/.

Before you begin with the CircleCI server v4.2 core services installation phase, ensure all xref:phase-1-prerequisites.adoc[prerequisites] are met.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
:toc: macro
:toc-title:

// This doc uses ifdef and ifndef directives to display or hide content specific to Google Cloud Storage (env-gcp) and AWS (env-aws). Currently, this affects only the generated PDFs. To ensure compatability with the Jekyll version, the directives test for logical opposites. For example, if the attribute is NOT env-aws, display this content. For more information, see https://docs.asciidoctor.org/asciidoc/latest/directives/ifdef-ifndef/.
// This doc uses ifdef and ifndef directives to display or hide content specific to Google Cloud Storage (env-gcp) and AWS (env-aws). Currently, this affects only the generated PDFs. To ensure compatibility with the Jekyll version, the directives test for logical opposites. For example, if the attribute is NOT env-aws, display this content. For more information, see https://docs.asciidoctor.org/asciidoc/latest/directives/ifdef-ifndef/.

Before you begin with the CircleCI server v4.2 execution environment installation phase, ensure you have run through xref:phase-1-prerequisites.adoc[Phase 1 – Prerequisites] and xref:phase-2-core-services.adoc[Phase 2 - Core Services Installation].

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
:toc: macro
:toc-title:

// This doc uses ifdef and ifndef directives to display or hide content specific to Google Cloud Storage (env-gcp) and AWS (env-aws). Currently, this affects only the generated PDFs. To ensure compatability with the Jekyll version, the directives test for logical opposites. For example, if the attribute is NOT env-aws, display this content. For more information, see https://docs.asciidoctor.org/asciidoc/latest/directives/ifdef-ifndef/.
// This doc uses ifdef and ifndef directives to display or hide content specific to Google Cloud Storage (env-gcp) and AWS (env-aws). Currently, this affects only the generated PDFs. To ensure compatibility with the Jekyll version, the directives test for logical opposites. For example, if the attribute is NOT env-aws, display this content. For more information, see https://docs.asciidoctor.org/asciidoc/latest/directives/ifdef-ifndef/.

Before you begin with the CircleCI server v4.2 post installation phase, ensure you have run through xref:air-gapped-installation:phase-1-prerequisites.adoc[Phase 1 – Prerequisites], xref:phase-2-core-services.adoc[Phase 2 - Core Services Installation] and xref:phase-3-execution-environments.adoc[Phase 3 - Execution Environments Installation].

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
:page-description: Find the general and infrastructure-specific requirements that are needed in order to configure the CircleCI server v4.3 application.
:experimental:

// This doc uses ifdef and ifndef directives to display or hide content specific to Google Cloud Storage (env-gcp) and AWS (env-aws). Currently, this affects only the generated PDFs. To ensure compatability with the Jekyll version, the directives test for logical opposites. For example, if the attribute is NOT env-aws, display this content. For more information, see https://docs.asciidoctor.org/asciidoc/latest/directives/ifdef-ifndef/.
// This doc uses ifdef and ifndef directives to display or hide content specific to Google Cloud Storage (env-gcp) and AWS (env-aws). Currently, this affects only the generated PDFs. To ensure compatibility with the Jekyll version, the directives test for logical opposites. For example, if the attribute is NOT env-aws, display this content. For more information, see https://docs.asciidoctor.org/asciidoc/latest/directives/ifdef-ifndef/.

CircleCI server v4.3 is installed as a Helm chart. The installation process is broken down into four phases. Each phase has a validation step at the end, allowing you to confirm success before moving to the next phase. Depending on your requirements, phases 3 and 4 may include multiple steps. This installation guide assumes you have already read the xref:overview:circleci-server-overview.adoc[CircleCI server v4.3 overview].

Expand Down Expand Up @@ -130,7 +130,7 @@ For high availability, and to avoid potential outages, you should provision subn
|===
--

[#minimum-permissions-requirments]
[#minimum-permissions-requirements]
=== Minimum permissions requirements

The installing user must have **at least** admin permissions for the namespace into which CircleCI is to be installed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
:page-description: Installation guide for CircleCI server v4.3 core services.
:experimental:

// This doc uses ifdef and ifndef directives to display or hide content specific to Google Cloud Storage (env-gcp) and AWS (env-aws). Currently, this affects only the generated PDFs. To ensure compatability with the Jekyll version, the directives test for logical opposites. For example, if the attribute is NOT env-aws, display this content. For more information, see https://docs.asciidoctor.org/asciidoc/latest/directives/ifdef-ifndef/.
// This doc uses ifdef and ifndef directives to display or hide content specific to Google Cloud Storage (env-gcp) and AWS (env-aws). Currently, this affects only the generated PDFs. To ensure compatibility with the Jekyll version, the directives test for logical opposites. For example, if the attribute is NOT env-aws, display this content. For more information, see https://docs.asciidoctor.org/asciidoc/latest/directives/ifdef-ifndef/.

Before you begin with the CircleCI server v4.3 core services installation phase, ensure all xref:phase-1-prerequisites.adoc[prerequisites] are met.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
:page-description: Installation guide for CircleCI server v4.3 execution environments.
:experimental:

// This doc uses ifdef and ifndef directives to display or hide content specific to Google Cloud Storage (env-gcp) and AWS (env-aws). Currently, this affects only the generated PDFs. To ensure compatability with the Jekyll version, the directives test for logical opposites. For example, if the attribute is NOT env-aws, display this content. For more information, see https://docs.asciidoctor.org/asciidoc/latest/directives/ifdef-ifndef/.
// This doc uses ifdef and ifndef directives to display or hide content specific to Google Cloud Storage (env-gcp) and AWS (env-aws). Currently, this affects only the generated PDFs. To ensure compatibility with the Jekyll version, the directives test for logical opposites. For example, if the attribute is NOT env-aws, display this content. For more information, see https://docs.asciidoctor.org/asciidoc/latest/directives/ifdef-ifndef/.

Before you begin with the CircleCI server v4.3 execution environment installation phase, ensure you have run through xref:phase-1-prerequisites.adoc[Phase 1 – Prerequisites] and xref:phase-2-core-services.adoc[Phase 2 - Core Services Installation].

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
:page-description: CircleCI server v4.3 post installation steps
:experimental:

// This doc uses ifdef and ifndef directives to display or hide content specific to Google Cloud Storage (env-gcp) and AWS (env-aws). Currently, this affects only the generated PDFs. To ensure compatability with the Jekyll version, the directives test for logical opposites. For example, if the attribute is NOT env-aws, display this content. For more information, see https://docs.asciidoctor.org/asciidoc/latest/directives/ifdef-ifndef/.
// This doc uses ifdef and ifndef directives to display or hide content specific to Google Cloud Storage (env-gcp) and AWS (env-aws). Currently, this affects only the generated PDFs. To ensure compatibility with the Jekyll version, the directives test for logical opposites. For example, if the attribute is NOT env-aws, display this content. For more information, see https://docs.asciidoctor.org/asciidoc/latest/directives/ifdef-ifndef/.

Before you begin with the CircleCI server v4.3 post installation phase, ensure you have run through xref:phase-1-prerequisites.adoc[Phase 1 – Prerequisites], xref:phase-2-core-services.adoc[Phase 2 - Core Services Installation] and xref:phase-3-execution-environments.adoc[Phase 3 - Execution Environments Installation].

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
:toc: macro
:toc-title:

// This doc uses ifdef and ifndef directives to display or hide content specific to Google Cloud Storage (env-gcp) and AWS (env-aws). Currently, this affects only the generated PDFs. To ensure compatability with the Jekyll version, the directives test for logical opposites. For example, if the attribute is NOT env-aws, display this content. For more information, see https://docs.asciidoctor.org/asciidoc/latest/directives/ifdef-ifndef/.
// This doc uses ifdef and ifndef directives to display or hide content specific to Google Cloud Storage (env-gcp) and AWS (env-aws). Currently, this affects only the generated PDFs. To ensure compatibility with the Jekyll version, the directives test for logical opposites. For example, if the attribute is NOT env-aws, display this content. For more information, see https://docs.asciidoctor.org/asciidoc/latest/directives/ifdef-ifndef/.

CircleCI server v4.4 is installed as a Helm chart. The installation process is broken down into four phases. There is a validation step at the end of each phase, allowing you to confirm success before moving to the next phase. Depending on your requirements, phases 3 and 4 may include multiple steps. This installation guide assumes you have already read the xref:overview:circleci-server-overview.adoc[CircleCI server v4.4 overview].

Expand Down Expand Up @@ -145,7 +145,7 @@ The application uses a large number of resources. Depending on your usage, your
|===
--

[#minimum-permissions-requirments]
[#minimum-permissions-requirements]
==== Minimum permissions requirements

The installing user must have **at least** admin permissions for the namespace into which CircleCI is to be installed.
Expand Down
Loading