Staged Deployments #1653

joepavitt · 2023-02-03T12:39:28Z

Description

Screen.Recording.2023-02-03.at.12.47.04.mov

This introduces a new section into the Project Settings labelled "DevOps". Similar to how the "Copy/Export" functionality works, a user can select a "Target" project, and push the latest version across. This is slightly less friction than the copy/export functionality as it defaults all of the options about which content to export from a Project (See linked issue for details on which features are exported).

Related Issue(s)

Closes #1580

Checklist

I have read the contribution guidelines
Suitable unit/system level tests have been added and they pass
Documentation has been updated
- [-] Upgrade instructions
- Configuration details
- Concepts
[-] Changes flowforge.yml?
- [-] Issue/PR raised on flowforge/helm to update ConfigMap Template
- [-] Issue/PR raised on flowforge/CloudProject to update values for Staging/Production

Labels

[-] Backport needed? -> add the backport label
[-] Includes a DB migration? -> add the area:migration label

…age" functionality

frontend/src/data/audit-events.json

frontend/src/pages/project/Overview.vue

frontend/src/pages/project/Settings/Danger.vue

frontend/src/pages/project/Settings/Stages.vue

frontend/src/pages/project/Settings/index.vue

frontend/src/pages/project/index.vue

docs/user/README.md

Co-authored-by: Zeger-Jan van de Weg <ZJvandeWeg@users.noreply.github.com>

…eudo-stages # Conflicts: # frontend/src/pages/project/index.vue

knolleary · 2023-02-03T13:57:32Z

It is quite hard to hold a discussion about the basic naming of these concept when it is split across so many individual comments. We need all of the terms to hang together as a whole.

There is a fundament design choice to be made around the terminology we choose to use.

We have been calling this work 'staged deployments' for a long time now. The concept being you have a pipeline of stages to get from your development stage to the production stage. That is not unusual terminology and has been what we've been discussed in the design work through out. It is consistent with various existing platforms.

We currently say you 'push' things between 'stages'. For the audit logging, we needed a verb for what happens to the target project. We went with import as we couldn't think of a suitable alternative that covered the cases it gets used for.

If we want different terminology, then rather than change the odd word, we need to make sure it all works together.

Do we call the steps of a pipeline 'stages' or 'environments' or something else
What do we call the action of moving stuff from one to the other? 'push' 'promote'
What do we call the action of a target project being updated?

joepavitt · 2023-02-03T14:00:48Z

Do we call the steps of a pipeline 'stages' or 'environments' or something else

Azure, AWS and IBM Cloud all use the term "Stages"

joepavitt · 2023-02-03T14:01:30Z

What do we call the action of moving stuff from one to the other? 'push' 'promote'

Currently, we have "Push", no objections to "Promote"

ZJvandeWeg · 2023-02-08T09:00:08Z

@joepavitt To practise Disagree and commit, let's move forward with Stages instead of environments.

ZJvandeWeg · 2023-02-03T13:27:54Z

frontend/src/pages/project/Settings/Stages.vue

+    <FormHeading>Pipeline Stages</FormHeading>
+    <FormRow>
+        <template #description>
+            <p class="mb-3">Here, you can configure a "Stage". This will enable you to deploy the updates to this project, directly onto the next "Stage" in your development Pipeline.</p>


Suggested change

<p class="mb-3">Here, you can configure a "Stage". This will enable you to deploy the updates to this project, directly onto the next "Stage" in your development Pipeline.</p>

<p class="mb-3">Here, you can configure an "Environment". This will enable you to deploy the updates to another project, directly onto the next stage in your development pipeline.</p>

ZJvandeWeg · 2023-02-08T08:57:17Z

frontend/src/pages/project/Settings/Danger.vue

            const options = {
                sourceProject: parts.sourceProject
            }
            projectApi.updateProject(parts.target, options)
+                .then(() => {
+                    alerts.emit(`Project export to '${parts.target}' has successfully started`, 'confirmation')


Help me a sec, what's the difference between export and copy to project?

frontend/src/pages/project/Settings/Stages.vue

frontend/src/data/audit-events.json

joepavitt · 2023-02-08T14:01:52Z

Help me a sec, what's the difference between export and copy to project?

Agreed that's not clear in the UI either. "Copy Project" I think should be renamed to "Duplicate Project". As it creates a new project in the process.

"Export to Existing Project" - that allows the user to define a subset of properties/content from your project and export that to another - essentially what we are using in Staged Deployments

knolleary · 2023-02-08T20:58:44Z

Agreed that's not clear in the UI either. "Copy Project" I think should be renamed to "Duplicate Project". As it creates a new project in the process.

Agreed.

…uplicate/export functions

joepavitt · 2023-02-10T09:47:09Z

@ZJvandeWeg just an fyi - I have steered away from the "Stages" terminology, and gone with a more general "DevOps" approach, having come back to it, the "Stages" option in the settings wasn't clear enough, hopefully this makes it better.

Have also made all of the changes requested re: labelling of buttons & feedback alerts

ZJvandeWeg · 2023-02-13T11:55:12Z

docs/user/project-stages.md

+In FlowForge it is possible to configure a DevOps pipeline for your Projects,
+these are done by configuring "Stages" in the Settings of a given Project.
+
+1. Navigate to your Project and click on the "Settings" option.


I think we should add a screenshot would be nice, if you can?

frontend/src/index.css

Co-authored-by: Zeger-Jan van de Weg <ZJvandeWeg@users.noreply.github.com>

frontend/src/pages/project/Settings/Danger.vue

joepavitt and others added 6 commits February 2, 2023 16:23

Add "Stages" settings, define "importing" state & develop "Push to St…

eea82c0

…age" functionality

Add "Project Staging" section into documentation

4321f13

Add audit logging for copying/staging projects

4b74b74

Add E2E Testing for Staged Deployments

185fd0c

Merge branch 'main' into 1580-pseudo-stages

ad4c978

Fix duplicate reply.send() calls after merge

a638442

ZJvandeWeg requested changes Feb 3, 2023

View reviewed changes

ZJvandeWeg reviewed Feb 3, 2023

View reviewed changes

docs/user/README.md Outdated Show resolved Hide resolved

joepavitt and others added 5 commits February 3, 2023 13:26

Update frontend/src/pages/project/index.vue

088c455

Co-authored-by: Zeger-Jan van de Weg <ZJvandeWeg@users.noreply.github.com>

Revert change to project watch function

058b9d7

Merge remote-tracking branch 'origin/1580-pseudo-stages' into 1580-ps…

b7c0120

…eudo-stages # Conflicts: # frontend/src/pages/project/index.vue

Remove unnecessary console.log

f59b42f

Consistent "stages" terminology in documentation

7f99f96

knolleary linked an issue Feb 3, 2023 that may be closed by this pull request

Pseudo-Staged Deployments #1580

Closed

3 tasks

ZJvandeWeg requested changes Feb 8, 2023

View reviewed changes

joepavitt added 2 commits February 9, 2023 16:42

"Copy Project" > "Duplicate Project" & More verbose descriptions of d…

b6614f3

…uplicate/export functions

Remove "Export Project" option

b560029

joepavitt and others added 5 commits February 10, 2023 09:48

Stages > DevOps Pipeline & clearer action/event labelling

9f9e7dc

/stages > /devops

176db8a

fix E2E tests path & header text check

d720458

Merge branch 'main' into 1580-pseudo-stages

56db4c4

fix merge issue

f215d9d

joepavitt requested a review from Pezmc February 13, 2023 09:24

ZJvandeWeg approved these changes Feb 13, 2023

View reviewed changes

Pezmc and others added 3 commits February 14, 2023 15:12

Update frontend/src/index.css

0d74d27

Co-authored-by: Zeger-Jan van de Weg <ZJvandeWeg@users.noreply.github.com>

Re-sort imports and component order

e8ef728

Delete removed project export dialog

b69aa5c

Pezmc approved these changes Feb 14, 2023

View reviewed changes

frontend/src/pages/project/Settings/Danger.vue Show resolved Hide resolved

Pezmc merged commit cab74a7 into main Feb 14, 2023

Pezmc deleted the 1580-pseudo-stages branch February 14, 2023 15:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Staged Deployments #1653

Staged Deployments #1653

joepavitt commented Feb 3, 2023 •

edited

Loading

knolleary commented Feb 3, 2023

joepavitt commented Feb 3, 2023

joepavitt commented Feb 3, 2023

ZJvandeWeg commented Feb 8, 2023

ZJvandeWeg Feb 3, 2023

ZJvandeWeg Feb 8, 2023

joepavitt commented Feb 8, 2023

knolleary commented Feb 8, 2023

joepavitt commented Feb 10, 2023 •

edited

Loading

ZJvandeWeg Feb 13, 2023

	<p class="mb-3">Here, you can configure a "Stage". This will enable you to deploy the updates to this project, directly onto the next "Stage" in your development Pipeline.</p>
	<p class="mb-3">Here, you can configure an "Environment". This will enable you to deploy the updates to another project, directly onto the next stage in your development pipeline.</p>

Staged Deployments #1653

Staged Deployments #1653

Conversation

joepavitt commented Feb 3, 2023 • edited Loading

Description

Related Issue(s)

Checklist

Labels

knolleary commented Feb 3, 2023

joepavitt commented Feb 3, 2023

joepavitt commented Feb 3, 2023

ZJvandeWeg commented Feb 8, 2023

ZJvandeWeg Feb 3, 2023

Choose a reason for hiding this comment

ZJvandeWeg Feb 8, 2023

Choose a reason for hiding this comment

joepavitt commented Feb 8, 2023

knolleary commented Feb 8, 2023

joepavitt commented Feb 10, 2023 • edited Loading

ZJvandeWeg Feb 13, 2023

Choose a reason for hiding this comment

joepavitt commented Feb 3, 2023 •

edited

Loading

joepavitt commented Feb 10, 2023 •

edited

Loading