Skip to content

Commit

Permalink
Merge branch 'main' into tk/deployments-overview-page-update
Browse files Browse the repository at this point in the history
  • Loading branch information
steve-fenton-octopus committed Mar 26, 2024
2 parents f8a331a + 4d25eeb commit ae25dc6
Show file tree
Hide file tree
Showing 38 changed files with 123 additions and 23 deletions.
14 changes: 7 additions & 7 deletions docs/credits.md

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
},
"devDependencies": {
"@playwright/test": "^1.39.0",
"csv-parse": "^5.5.5",
"npm-run-all": "^4.1.5",
"onchange": "^7.1.0",
"prettier": "^3.2.5",
Expand Down
7 changes: 7 additions & 0 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions public/docs/css/main.css
Original file line number Diff line number Diff line change
Expand Up @@ -561,8 +561,8 @@ nav.skip-links a:focus {

.docs-home {
text-align: center;
margin-block-start: 10vh;
margin-block-end: 10vh;
margin-block-start: 5vh;
margin-block-end: 5vh;
}

/* card */
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/docs/i/1000/helm-logo.webp
Binary file not shown.
Binary file added public/docs/i/1000/kustomize-octopus-logo.webp
Binary file not shown.
Binary file added public/docs/i/1000/octopus-deploy-logo.webp
Binary file not shown.
Binary file added public/docs/i/1000/yaml-logo.webp
Binary file not shown.
Binary file added public/docs/i/2000/helm-logo.webp
Binary file not shown.
Binary file added public/docs/i/2000/kustomize-octopus-logo.webp
Binary file not shown.
Binary file added public/docs/i/2000/octopus-deploy-logo.webp
Binary file not shown.
Binary file added public/docs/i/2000/yaml-logo.webp
Binary file not shown.
Binary file added public/docs/i/600/helm-logo.webp
Binary file not shown.
Binary file added public/docs/i/600/kustomize-octopus-logo.webp
Binary file not shown.
Binary file added public/docs/i/600/octopus-deploy-logo.webp
Binary file not shown.
Binary file added public/docs/i/600/yaml-logo.webp
Binary file not shown.
Binary file added public/docs/i/x/helm-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/docs/i/x/kustomize-octopus-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/docs/i/x/octopus-deploy-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/docs/i/x/yaml-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/docs/img/helm-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions public/docs/img/helm-logo.png.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"width":640,"height":228}
Binary file added public/docs/img/kustomize-octopus-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions public/docs/img/kustomize-octopus-logo.png.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"width":640,"height":228}
Binary file added public/docs/img/octopus-deploy-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions public/docs/img/octopus-deploy-logo.png.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"width":640,"height":228}
Binary file added public/docs/img/yaml-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions public/docs/img/yaml-logo.png.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"width":640,"height":228}
5 changes: 2 additions & 3 deletions src/pages/docs.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: src/layouts/Default.astro
pubDate: 2023-01-01
modDate: 2023-11-14
modDate: 2024-03-18
title: Hello, Octopus Deploy! 👋
subtitle: Best-of-breed Continuous Delivery
navTitle: Introduction
Expand Down Expand Up @@ -73,7 +73,7 @@ If you deliver software to Kubernetes, our [Kubernetes overview](/docs/deploymen

If you enjoy learning via video, the Octopus 101 recording below also serves as a great introduction to the key Octopus concepts in the context of modern deployments.

<iframe width="840" height="473" src="https://www.youtube.com/embed/y5wP_H_1VqY?si=hInE-4O88e_0FHt1" title="Octopus Deploy 101 YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
[Watch the Octopus 101](https://www.youtube.com/watch?v=y5wP_H_1VqY)

## We’re here to help

Expand All @@ -88,7 +88,6 @@ If you get stuck or just need advice, we’re here to help.

Happy deployments!


## Recent changes

<RecentlyUpdated count="5" />
86 changes: 86 additions & 0 deletions src/pages/docs/deployments/deployment-freezes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
---
layout: src/layouts/Default.astro
pubDate: 2024-03-25
modDate: 2024-03-25
title: Deployment freezes
description: Deployment freezes allow you to pause deployments for a specified time range
navOrder: 170
---

:::div{.hint}
Deployment freezes will be available for early access from Octopus Deploy **2024.2**. Please contact michelle.obrien@octopus.com if you would like to turn this feature on.
:::

:::div{.hint}
As this is an early access feature, we are aware of some flaws in the UI when assigning projects and environments to the deployment freeze. If you have feedback regarding this feature please contact michelle.obrien@octopus.com.
:::

Deployment freezes allow you to pause deployments across all spaces for a configured amount of time. This is useful when you want to prevent certain projects deploying to certain environments within a specific time frame. Without deployment freezes, you would need to manually disable specific projects or machines to stop the deployments.

An example of how deployment freezes could be used is:

- Freezing deployments for all projects to the production environment during the holiday shut-down period.

As deployment freezes are scoped to projects and environments, both projects and environments will need to be assigned to the freeze. This will ensure that projects and environments that are not frozen will still deploy.


## Pre-requisites
As a deployment freeze needs to be scoped to projects and environments, projects and environments will need to be created before a deployment freeze can be created.


## Create a deployment freeze
1. Navigate to **Configuration ➜ Deployment Freezes** and click **ADD DEPLOYMENT FREEZE**
2. Enter a name for your deployment freeze
3. Set a start and end time for your freeze
4. Assign projects and environments to your freeze by clicking **ASSIGN SCOPE** and navigating through the wizard. At least 1 project and 1 environment per project must be selected to create a freeze.
5. Save


## Scoping deployment freezes
Deployment freezes can be scoped in the following ways:
- Projects
- Environments

During deployment, Octopus will block deployments for projects to a certain environment if a freeze is scoped to that project and environment. For example, if a freeze is active and is assigned to Project A in Production, Project A will not be deployed to Production but can still be deployed to any other environment according to the lifecycle.


## Permissions
To create and edit a deployment freeze, the DeploymentFreezeAdminister system permission is required. In addition, permissions will need to be scoped to all requested projects and environments when creating, editing or overriding a deployment freeze.

For example, imagine a deployment freeze that applies to
* Car Rental project
* To the Production environment

You will be allowed to view this deployment freeze on the **Deployment Freezes** page if your user doesn't have the DeploymentFreezeAdminister system permission. If your user has the DeploymentFreezeAdminister system permission and permissions scoped to the Car Rental project and Production environment, they will be able to view, edit and override this freeze.


## Overriding a freeze
Following on from the example above, imagine a scenario where a deployment freeze is currently active for the Car Rental project to the Production environment. While the freeze is active, a developer discovers that there is a bug in the production code and a fix needs to be rolled out immediately. In this scenario, the freeze can be overridden to deploy the fix to Production even while the freeze is active. After the fix is deployed, the freeze will still be in place and behave as expected.

To override a freeze:
- Navigate to the **Deploy A Release** page of your chosen project.
- You should see an information box that shows the affected environments in the freeze
- If you have the correct permissions, the Deploy button should be green.

:::figure
![Override a deployment freeze from deploy a release page](/docs/deployments/deployment-freeze-override.png)
:::

- Click the **DEPLOY** button and enter a reason for the override in the dialog box.
- Click **OVERRIDE AND DEPLOY**

:::figure
![Override a deployment freeze confirmation dialog](/docs/deployments/deployment-freeze-override-dialog-confirm.png)
:::


## Current limitations
- Deployment freezes are not yet integrated with our [Executions API](https://octopus.com/blog/faster-deployments-with-the-executions-api).
- Deployment freezes currently block [automatic deployments](/docs/deployments/patterns/elastic-and-transient-environments/immutable-infrastructure/#ImmutableInfrastructure-Automaticallydeploying)


## Learn more

- [Projects](/docs/projects/)
- [Environments](/docs/infrastructure/environments/index)
- Learn more about our concept of [Spaces](/docs/administration/spaces)
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,14 @@ pubDate: 2023-01-01
modDate: 2024-03-20
title: Kubernetes
description: Octopus Deploy provides support for deploying Kubernetes resources.
navOrder: 10
navOrder: 80
hideInThisSectionHeader: true
---
import RecentlyUpdated from '@components/RecentlyUpdated.astro';
import Card from 'src/components/Card.astro';

Octopus Deploy makes it easy to manage your Kubernetes resources, whether you're starting simple or want complete control over a complex setup. This section has everything you need to know about using Octopus for Kubernetes CD.

- Tutorials and guides for different deployment scenarios, from a simple proof of concept to enterprise-scale GitOps
- Kubernetes best practices
- Octopus documentation for built-in steps and targets

:::figure
![Kubernetes pipeline](/docs/deployments/kubernetes/pipeline-visual-k8s.png)
:::
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: src/layouts/Default.astro
pubDate: 2023-01-01
modDate: 2023-01-01
modDate: 2024-03-22
title: SSH target requirements
description: Requirements for using SSH deployment targets with Octopus.
navOrder: 15
Expand Down Expand Up @@ -60,7 +60,7 @@ Self-contained Calamari is built as a [.NET Core self-contained distributable](h

### Self-Contained .NET Core dependencies {#self-contained-net-core-dependencies}

[.NET Core has some dependencies](https://github.com/dotnet/core/blob/main/Documentation/prereqs/) which must be installed on the target server.
[.NET Core has some dependencies](https://learn.microsoft.com/en-us/dotnet/core/install/linux-scripted-manual#dependencies) which must be installed on the target server.

## Calamari on Mono {#mono-calamari}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: src/layouts/Default.astro
pubDate: 2023-01-01
modDate: 2024-03-11
modDate: 2024-03-22
title: Linux Tentacle
description: How to install and configure Octopus Tentacles on Linux Servers in either listening or polling mode.
navOrder: 20
Expand All @@ -20,7 +20,7 @@ Before you can configure a Linux Tentacle, the Linux server must meet the [requi

- Octopus Server **2019.8.3** or newer

Linux Tentacle is a .NET application distributed as a [self-contained deployment](https://docs.microsoft.com/en-us/dotnet/core/deploying/#publish-self-contained). On most Linux distributions it will *just work*, but be aware that [you will need to install .NET](https://learn.microsoft.com/en-us/dotnet/core/install/linux).
Linux Tentacle is a .NET application distributed as a [self-contained deployment](https://docs.microsoft.com/en-us/dotnet/core/deploying/#publish-self-contained). On most Linux distributions it will *just work*, but be aware that [you will need to install some prerequisites](https://learn.microsoft.com/en-us/dotnet/core/install/linux-scripted-manual#dependencies).

## Known limitations

Expand Down
11 changes: 9 additions & 2 deletions src/pages/docs/support/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,13 @@ description: Information explaining how to perform requested tasks by Octopus su
navOrder: 160
---

Sometimes when you contact support we might ask you to perform tasks on your Octopus. This section explains how to perform some of those tasks.
To enquire about purchasing, renewing, or upgrading your Octopus license, please [contact our sales team](https://octopus.com/company/contact).

If you need product help and have a paid license, or you're trialing Octopus, please [email our support team](mailto:support@octopus.com). You can also visit our [Support page](https://octopus.com/support).

Sometimes when you contact support, we might ask you to perform tasks in Octopus. This section explains how to perform some of those tasks.

:::div{.hint}
Priority Support is available as an addition to your Octopus Enterprise license. For more information, please see our [Priority Support page](https://octopus.com/support/priority).
:::

To contact Octopus support, please visit the [support page](https://octopus.com/support).

0 comments on commit ae25dc6

Please sign in to comment.