Skip to content

Commit 849224c

Browse files
committed
Add upgrade scripts, upgrade docs
1 parent 8fe0952 commit 849224c

File tree

5 files changed

+333
-65
lines changed

5 files changed

+333
-65
lines changed

docs.openc3.com/docs/getting-started/upgrading.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,37 @@ Downgrades are not necessarily supported. When upgrading COSMOS we need to upgra
125125
In general, patch releases (x.y.Z) can be downgraded, minor releases (x.Y.z) _might_ be able to be downgraded and major releases (X.y.z) are NOT able to be downgraded.
126126
:::
127127

128+
## Upgrading from COSMOS Core to COSMOS Enterprise
129+
130+
Going from COSMOS Core (open source) to COSMOS Enterprise (OpenC3 customer) is a straight forward process that will preserve all your data collected by COSMOS Core.
131+
132+
:::info Coming Soon
133+
This process is being simplified in an upcoming release and will be integrated into the `openc3.sh upgrade` command.
134+
:::
135+
136+
If you currently are using the `cosmos-project` repo to run COSMOS then you should separately clone the `cosmos-enterprise-project` repo at the same release tag and simply copy over the various files.
137+
138+
The process should loook something like this:
139+
140+
1. Clone the `cosmos-enterprise-project` and checkout the equivalent tag. You'll need to ensure you have your Personally Access Token set to clone the repo. See the project [README](https://github.com/OpenC3/cosmos-enterprise-project) for help.
141+
142+
`git clone https://github.com/OpenC3/cosmos-enterprise-project.git`
143+
`git checkout v6.9.2`
144+
145+
2. From your current `cosmos-project` directory, stop the current COSMOS application
146+
147+
`openc3.sh stop`
148+
149+
3. Copy the project files from the Enterprise project to your current project
150+
151+
`cp -r cosmos-enterprise-project/* .`
152+
153+
4. Start the new Enterprise application
154+
155+
`openc3.sh run`
156+
157+
5. Test and verify functionality and commit your changes.
158+
128159
## Migrating From COSMOS 5 to COSMOS 6
129160

130161
:::info Developers Only

openc3.bat

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ GOTO :EOF
168168
GOTO :EOF
169169

170170
:test
171-
REM Building OpenC3
171+
REM Building COSMOS
172172
CALL scripts\windows\openc3_setup || exit /b
173173
docker compose -f compose.yaml -f compose-build.yaml build
174174
set args=%*
@@ -201,24 +201,24 @@ GOTO :EOF
201201
:usage
202202
if "%OPENC3_DEVEL%" == "1" (
203203
if "%OPENC3_ENTERPRISE%" == "1" (
204-
@echo OpenC3 - Command and Control System (Enterprise Development Installation) 1>&2
204+
@echo OpenC3 COSMOS - Command and Control System (Enterprise Development Installation) 1>&2
205205
) else (
206-
@echo OpenC3 - Command and Control System (Development Installation) 1>&2
206+
@echo OpenC3 COSMOS - Command and Control System (Development Installation) 1>&2
207207
)
208208
) else (
209209
if "%OPENC3_ENTERPRISE%" == "1" (
210-
@echo OpenC3 - Command and Control System (Enterprise Runtime-Only Installation) 1>&2
210+
@echo OpenC3 COSMOS - Command and Control System (Enterprise Runtime-Only Installation) 1>&2
211211
) else (
212-
@echo OpenC3 - Command and Control System (Runtime-Only Installation) 1>&2
212+
@echo OpenC3 COSMOS - Command and Control System (Runtime-Only Installation) 1>&2
213213
)
214214
)
215215
@echo Usage: %0 COMMAND [OPTIONS] 1>&2
216216
@echo. 1>&2
217217
@echo DESCRIPTION: 1>&2
218-
@echo OpenC3 is a command and control system for embedded systems. This script 1>&2
218+
@echo COSMOS is a command and control system for embedded systems. This script 1>&2
219219
if "%OPENC3_DEVEL%" == "1" (
220220
@echo provides a convenient interface for building, running, testing, and managing 1>&2
221-
@echo OpenC3 in Docker containers. 1>&2
221+
@echo COSMOS in Docker containers. 1>&2
222222
@echo. 1>&2
223223
if "%OPENC3_ENTERPRISE%" == "1" (
224224
@echo This is an ENTERPRISE DEVELOPMENT installation with source code and build capabilities. 1>&2
@@ -227,7 +227,7 @@ GOTO :EOF
227227
)
228228
) else (
229229
@echo provides a convenient interface for running, testing, and managing 1>&2
230-
@echo OpenC3 in Docker containers. 1>&2
230+
@echo COSMOS in Docker containers. 1>&2
231231
@echo. 1>&2
232232
if "%OPENC3_ENTERPRISE%" == "1" (
233233
@echo This is an ENTERPRISE RUNTIME-ONLY installation using pre-built images. 1>&2
@@ -238,35 +238,35 @@ GOTO :EOF
238238
@echo. 1>&2
239239
@echo COMMON COMMANDS: 1>&2
240240
if "%OPENC3_DEVEL%" == "1" (
241-
@echo start Build and run OpenC3 (equivalent to: build + run) 1>&2
242-
@echo This is the typical command to get OpenC3 running. 1>&2
241+
@echo start Build and run COSMOS (equivalent to: build + run) 1>&2
242+
@echo This is the typical command to get COSMOS running. 1>&2
243243
@echo. 1>&2
244244
) else (
245-
@echo run Start OpenC3 containers 1>&2
245+
@echo run Start COSMOS containers 1>&2
246246
@echo Access at: http://localhost:2900 1>&2
247247
@echo. 1>&2
248248
)
249-
@echo stop Stop all running OpenC3 containers gracefully 1>&2
249+
@echo stop Stop all running COSMOS containers gracefully 1>&2
250250
@echo Allows containers to shutdown cleanly. 1>&2
251251
@echo. 1>&2
252-
@echo cli [COMMAND] Run OpenC3 CLI commands in a container 1>&2
252+
@echo cli [COMMAND] Run COSMOS CLI commands in a container 1>&2
253253
@echo Use 'cli help' for available commands 1>&2
254254
@echo Examples: 1>&2
255255
@echo %0 cli generate plugin MyPlugin 1>&2
256256
@echo %0 cli validate myplugin.gem 1>&2
257257
@echo. 1>&2
258-
@echo cliroot [COMMAND] Run OpenC3 CLI commands as root user 1>&2
258+
@echo cliroot [COMMAND] Run COSMOS CLI commands as root user 1>&2
259259
@echo For operations requiring root privileges 1>&2
260260
@echo. 1>&2
261261
if "%OPENC3_DEVEL%" == "1" (
262262
@echo DEVELOPMENT COMMANDS: 1>&2
263-
@echo build Build all OpenC3 Docker containers from source 1>&2
263+
@echo build Build all COSMOS Docker containers from source 1>&2
264264
@echo Required before first run or after code changes. 1>&2
265265
@echo. 1>&2
266-
@echo run Start OpenC3 containers in detached mode 1>&2
266+
@echo run Start COSMOS containers in detached mode 1>&2
267267
@echo Access at: http://localhost:2900 1>&2
268268
@echo. 1>&2
269-
@echo dev Start OpenC3 containers in development mode 1>&2
269+
@echo dev Start COSMOS containers in development mode 1>&2
270270
@echo Uses compose-dev.yaml for development. 1>&2
271271
@echo. 1>&2
272272
)
@@ -277,20 +277,20 @@ GOTO :EOF
277277
@echo Use '%0 util' to see available utilities. 1>&2
278278
@echo. 1>&2
279279
if "%OPENC3_DEVEL%" == "0" (
280-
@echo upgrade Upgrade OpenC3 to latest version 1>&2
280+
@echo upgrade Upgrade COSMOS to latest version 1>&2
281281
@echo Downloads and installs latest release. 1>&2
282282
@echo. 1>&2
283283
)
284284
@echo CLEANUP: 1>&2
285285
@echo cleanup [OPTIONS] Remove Docker volumes and data 1>&2
286-
@echo WARNING: This deletes all OpenC3 data! 1>&2
286+
@echo WARNING: This deletes all COSMOS data! 1>&2
287287
@echo Options: 1>&2
288288
@echo local - Also remove local plugin files 1>&2
289289
@echo force - Skip confirmation prompt 1>&2
290290
@echo. 1>&2
291291
@echo GETTING STARTED: 1>&2
292292
@echo 1. First time setup: %0 start 1>&2
293-
@echo 2. Access OpenC3: http://localhost:2900 1>&2
293+
@echo 2. Access COSMOS: http://localhost:2900 1>&2
294294
@echo 3. Stop when done: %0 stop 1>&2
295295
@echo 4. Remove everything: %0 cleanup 1>&2
296296
@echo. 1>&2

0 commit comments

Comments
 (0)