Skip to content

Commit

Permalink
Merge pull request #2215 from OctopusDeploy/tk/deployments-overview-p…
Browse files Browse the repository at this point in the history
…age-update

Updating Deployments Overview page
  • Loading branch information
tonykelly-octopus authored Mar 26, 2024
2 parents 4d25eeb + e538891 commit a737d6d
Show file tree
Hide file tree
Showing 21 changed files with 105 additions and 44 deletions.
11 changes: 11 additions & 0 deletions dictionary-octopus.txt
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ Dockerfiles
dockerhub
DONTVALIDATEPATH
dpkg
Dspring
emptytitle
Fargate
feedcred
Expand Down Expand Up @@ -105,11 +106,14 @@ majeure
maxage
mdast
milli
minifier
MITM
Moines
mozjpeg
mozroots
msiexec
MTTR
myapplication
myfeature
navigationid
NETBIOS
Expand All @@ -131,6 +135,7 @@ octopuslabs
octopusservernodes
octopustarget
octopusvariable
Octostash
Octostache
octoterra
OIDC
Expand All @@ -151,6 +156,7 @@ pycryptodome
querystring
quickstart
QUOTENAME
Redgate
rehype
reindexing
releaseprogression
Expand All @@ -160,6 +166,7 @@ reprovisioned
reprovisioning
robocopy
roboto
rolename
rootelement
RSASSA
Runbook
Expand All @@ -180,6 +187,7 @@ srcset
srcset
sthumb
stylesheet
subcontext
swaggerui
systemprofile
tabpanel
Expand All @@ -188,6 +196,7 @@ templateid
templating
tenanttype
TFVC
thepassword
tmpfs
toptags
Traefik
Expand All @@ -204,9 +213,11 @@ useronboarding
variablename
Voltron
WCAG
webapps
webfonts
webserver
WEBSVR
WFLYUT
WIXUI
Wildfly
workerpool
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.
Binary file added public/docs/deployments/octopus-variables.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion src/pages/docs/deployments/azure/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ pubDate: 2023-01-01
modDate: 2023-01-01
title: Azure
description: Octopus Deploy can help you perform repeatable and controlled deployments of your applications into Azure.
navOrder: 30
navOrder: 40
hideInThisSectionHeader: true
---

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/deployments/bulk-deployment-creation.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ pubDate: 2023-09-13
modDate: 2023-09-13
title: Bulk deployment creation
description: Octopus Deploy can use bulk deployment creation when deploying to multiple environments or tenants
navOrder: 160
navOrder: 170
---

:::div{.hint}
Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/deployments/certificates/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ pubDate: 2023-01-01
modDate: 2023-01-01
title: Certificates
description: Manage X.509 certificates with Octopus Deploy
navOrder: 40
navOrder: 80
hideInThisSectionHeader: true
---

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/deployments/custom-scripts/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ pubDate: 2023-01-01
modDate: 2023-11-01
title: Custom scripts
description: Custom scripts allows you to script anything you want using PowerShell, ScriptCS, F#, Python, or Bash.
navOrder: 120
navOrder: 150
---

As a convention-oriented deployment tool, Octopus can perform a number of actions automatically, such as configuring common types of applications and deploying them to popular hosting environments. For these situations, we have built everything you need into Octopus. Sometimes, however, you need to do more than the built-in conventions support, and that's where custom scripts come in.
Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/deployments/databases/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ pubDate: 2023-01-01
modDate: 2023-01-01
title: Databases
description: Database deployments
navOrder: 50
navOrder: 90
hideInThisSectionHeader: true
---

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/deployments/dotnet/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ pubDate: 2023-01-01
modDate: 2023-01-01
title: .NET deployments
description: Octopus Deploy can help you perform repeatable, reliable deployments of your .NET applications.
navOrder: 10
navOrder: 50
hideInThisSectionHeader: true
---

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/deployments/google-cloud/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ pubDate: 2023-01-01
modDate: 2023-01-01
title: Google Cloud
description: Octopus Deploy can help you perform repeatable and controlled deployments of your applications into Google Cloud Platform (GCP).
navOrder: 35
navOrder: 30
hideInThisSection: true
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ pubDate: 2023-01-01
modDate: 2023-01-01
title: HTML and JavaScript applications
description: This guide provides a simple example of deploying and configuring a simple JavaScript application built using AngularJS.
navOrder: 150
navOrder: 160
---

We are commonly asked how to deploy and configure HTML/JS or Single Page Applications (SPA) running in a browser, or JavaScript applications running in Node.js. This guide provides a simple example of deploying and configuring a simple JavaScript application using AngularJS.
Expand Down Expand Up @@ -53,7 +53,7 @@ angular
</html>
```

### Step 1: Upload the package to the built-in repository {#DeployingHTMLandJavaScriptApplications-Step1-Uploadthepackagetothebuilt-inrepository}
### Step 1: Upload the package to the built-in repository {#upload-the-package}

Firstly we need to make the package available for Octopus to deploy.

Expand All @@ -68,7 +68,7 @@ We've crafted and packaged v1.0.0 of this sample application for you to try out
![](/docs/deployments/images/5866205.png)
:::

### Step 2: Create the project, variables and deployment process {#DeployingHTMLandJavaScriptApplications-Step2-Createtheproject,variablesanddeploymentprocess}
### Step 2: Create the project, variables and deployment process {#create-the-project}

Now we need to create the project and configure it ready to deploy our JavaScript application.

Expand Down Expand Up @@ -96,7 +96,7 @@ Now we need to create the project and configure it ready to deploy our JavaScrip
![](/docs/deployments/images/5866210.png)
:::

### Step 3: Deploy {#DeployingHTMLandJavaScriptApplications-Step3-Deploy}
### Step 3: Deploy {#deploy}

Now when we create a release for this project and deploy it we can see that Octopus has found the `MyApp.html` file and substituted the variable values into our expressions.

Expand All @@ -112,7 +112,7 @@ And finally when we load the application in our browser we can see the results h

![](/docs/deployments/images/5866211.png)

### Step 4: Minify the JavaScript and deploy again {#DeployingHTMLandJavaScriptApplications-Step4-MinifytheJavaScriptanddeployagain!}
### Step 4: Minify the JavaScript and deploy again {#minify-and-deploy}

This approach also works perfectly with minified sources. This is because the minifier won't change string literals like `"#{MyApp.ConfigValue1}"` and the substitution will work just like it did before. In this example we will just minify the JavaScript inline in the HTML file. You can get the same result by moving the JavaScript into an external file and minifying that.

Expand Down Expand Up @@ -142,6 +142,6 @@ angular.module("myApp",[]).constant("myConfig",{configValue1:"#{MyApp.ConfigValu
</html>
```

## Next steps {#DeployingHTMLandJavaScriptApplications-Nextsteps}
## Next steps {#next-steps}

From this point you could build on this example, pushing configuration variables through from Octopus to your application. You may want to consider how granular you make each constant, perhaps combining related configuration data into the same JSON object.
23 changes: 0 additions & 23 deletions src/pages/docs/deployments/index.md

This file was deleted.

73 changes: 73 additions & 0 deletions src/pages/docs/deployments/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
---
layout: src/layouts/Default.astro
pubDate: 2023-01-01
modDate: 2024-03-19
title: Deployments
navTitle: Overview
navSection: Deployments
description: Deployment examples, patterns and practices, and their practical implementation using Octopus.
navOrder: 80
hideInThisSectionHeader: true
---

Great deployments are stress-free deployments. They should be non-events that ‘just work’ without the need for sign-off from multiple gatekeepers.

You can use Octopus to deploy anything, anywhere. Whether it’s [Kubernetes](/docs/deployments/kubernetes), [Linux](/docs/infrastructure/deployment-targets/linux/), or [Windows](/docs/deployments/windows) virtual machines, [Amazon Web Services](/docs/deployments/aws), [Azure](/docs/deployments/azure), or [Google Cloud](/docs/deployments/google-cloud), if Octopus can speak to it via our Tentacle agent, SSH, command-line, or a web service, Octopus can deploy to it.

## Why deploy with Octopus?

Octopus models deployments in advanced ways, letting you tame complexity at scale.

Octopus is about more than just automating your existing deployment process. It has features that streamline the complex aspects of deployments, where manual and scripted deployments often fail.

Deploying software with Octopus involves [packaging your applications](/docs/packaging-applications/) and [configuring your infrastructure](/docs/infrastructure/). With those two completed, you’ll use the following features to complete your deployment setup in Octopus.

### Deployment process
The Octopus [deployment process](/docs/projects/deployment-process/) lets you define all the tasks needed to deploy your software. The process acts like a deployment checklist, making sure each task gets completed before proceeding to the next one.

Critically, unlike a manual checklist, Octopus never forgets to run a step and always completes them in the correct order.

:::figure
![Octopus deployment process](/docs/deployments/octopus-deployment-process.png)
:::

### Steps
Octopus provides a library of [pre-built step templates](/docs/projects/steps) for deployment tasks, offering a simpler configuration experience by separating scripts and API calls.
These steps can be easily added to processes, with configurations allowing for conditions based on environments, channels, previous steps, or package acquisition. Options include running steps in parallel or sequence, setting time limits, and configuring retries for failed steps.

:::figure
![Octopus process step templates](/docs/deployments/octopus-step-templates.png)
:::

There's also a [community library](https://library.octopus.com/) with over 500 step templates, so you can complete tasks without coding. You can still create custom script steps or develop your own custom step templates for use across projects.

#### Guided failure mode and step retries
You can configure deployments to fail in Octopus when there’s an error. Guided failure mode and step retries are alternative options to outright failing the deployment.

[Guided failure](/docs/releases/guided-failures) mode pauses the deployment when a step fails and lets you retry the failed step (after fixing any errors if needed), skip it, or fail the deployment.

When switched on, step retries re-attempts to run the failed step 3 times before it gives up and fails the deployment. This is useful when there's a temporary network issue and the destination is temporarily unavailable.

### Variables
Octopus [variables](/docs/projects/variables/) let you apply the correct variables easily during a deployment. Octopus can manage simple values, secrets, and accounts as variables.

:::figure
![Octopus variables](/docs/deployments/octopus-variables.png)
:::

You can scope variables by:

- Environments
- Deployment target roles
- Deployment targets
- Deployment processes and steps
- Channels

### Releases
A [release](/docs/releases/) in Octopus is a snapshot of the deployment process and assets at creation, ensuring consistency in deployments. Changes to assets don't affect existing releases.

Tenant variables get excluded, so it's easier to onboard new tenants without needing a new release.

## Getting started with deployments

Use the navigation to discover deployment examples for different types of applications and technologies using Octopus. It also includes [common deployment patterns and practices](/docs/deployments/patterns).
2 changes: 1 addition & 1 deletion src/pages/docs/deployments/java/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ pubDate: 2023-01-01
modDate: 2023-10-04
title: Java applications
description: Deploy to WildFly, Red Hat JBoss EAP and Tomcat using Octopus Deploy
navOrder: 70
navOrder: 110
hideInThisSectionHeader: true
---

Expand Down
4 changes: 2 additions & 2 deletions src/pages/docs/deployments/kubernetes/index.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
layout: src/layouts/Default.astro
pubDate: 2023-01-01
modDate: 2024-03-20
modDate: 2024-03-26
title: Kubernetes
description: Octopus Deploy provides support for deploying Kubernetes resources.
navOrder: 80
navOrder: 10
hideInThisSectionHeader: true
---
import RecentlyUpdated from '@components/RecentlyUpdated.astro';
Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/deployments/nginx/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ pubDate: 2023-01-01
modDate: 2023-01-01
title: NGINX deployments
description: This guide covers everything you need to configure NGINX on Linux for your web applications
navOrder: 90
navOrder: 120
hideInThisSectionHeader: true
---

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/deployments/node-js/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ pubDate: 2023-01-01
modDate: 2023-01-01
title: Node deployments
description: With Octopus Deploy you can deploy your Node.JS applications to on-premises servers, Azure websites, Azure and AWS EC2 virtual machines.
navOrder: 100
navOrder: 130
hideInThisSectionHeader: true
---

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/deployments/packages/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ pubDate: 2023-01-01
modDate: 2023-06-28
title: Packages
description: Package steps allow you to deploy your applications and services that you have packaged and configured with Octopus.
navOrder: 110
navOrder: 140
---

When defining your [deployment process](/docs/deployments/), the most common step type will be a package step. This step deploys your [packaged application](/docs/packaging-applications) onto one or more deployment targets.
Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/deployments/terraform/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ pubDate: 2023-01-01
modDate: 2023-01-01
title: Terraform
description: Terraform deployments
navOrder: 130
navOrder: 100
hideInThisSectionHeader: true
---

Expand Down
2 changes: 1 addition & 1 deletion src/pages/docs/deployments/windows/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ pubDate: 2023-01-01
modDate: 2023-01-01
title: Windows
description: Deployment examples for Windows, including Services, IIS websites and app pools, and more.
navOrder: 140
navOrder: 70
---

Windows is a popular Operating system to deploy your software to. Out-of-the-box, Octopus provides built-in steps to deploy to Windows including Windows Services, IIS and more.

0 comments on commit a737d6d

Please sign in to comment.