Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc/Enterprise#431 - Move production version to enterprise #1072

Merged
merged 2 commits into from
Aug 26, 2024
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
8 changes: 8 additions & 0 deletions docs/manuals/cli/manage-versions.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@ Below is the list of all the optional arguments:
- *--delete-production VERSION* or *-dp VERSION*: Converts the provided production version
to an experiment version.

!!! warning "Available in Taipy Enterprise edition"

The *--delete-production* option is relevant only to the Enterprise edition of Taipy.

## List capabilities with the --help option

To display the help message of the `manage-version` command, you can run
Expand Down Expand Up @@ -135,6 +139,10 @@ d74ec95e-6b98-4612-b50b-d171599fa3e9 Development (latest) 2023-01-19 14:45:1

## Remove a version from production

!!! warning "Available in Taipy Enterprise edition"

This section is relevant only to the Enterprise edition of Taipy.

To convert a version from production to experiment, you can run the version management command
with *--delete-production* option.

Expand Down
4 changes: 3 additions & 1 deletion docs/manuals/userman/configuration/core-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,9 @@ Here are the (optional) configurable properties:
_**application_db**_, _**properties**_. Please refer to
[MongoDB storage section](core-config.md#mongodb-storage-for-taipy-entities).
- _**mode**_: A string that indicates the mode of the version management system.
Possible values are *"development"*, *"experiment"*, or *"production"*.
Possible values are *"development"* or *"experiment"*. On Enterprise edition of Taipy,
*production* mode is also available. Please refer to the
[Versioning management](../versioning/index.md) documentation page for more details.
- _**version_number**_: The identifier of the version. In development mode, the version number
is ignored.
- _**force**_: Indicates whether Taipy will override a version even if the configuration has
Expand Down
2 changes: 1 addition & 1 deletion docs/manuals/userman/versioning/experiment_mode.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ option on the Taipy CLI and provide the version name (see the

```console
$ taipy manage-versions --delete 0.1
Successfully deleted version 0.1 from the production version list.
Successfully delete version 0.1.

$ taipy manage-versions --list
Version number Mode Creation date
Expand Down
6 changes: 5 additions & 1 deletion docs/manuals/userman/versioning/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Taipy proposes a **version management system** to:
## Modes

Taipy requires a *mode* to run. A mode corresponds to how Taipy behaves at runtime regarding old
entities instantiated in previous runs. There are three runtime modes that can be used when running
entities instantiated in previous runs. There are different runtime modes that can be used when running
a Taipy application.

- In development mode (default mode), Taipy drops all old entities before running the application.
Expand All @@ -39,6 +39,10 @@ a Taipy application.
environment with existing entities created in previous runs. For more information, please refer to
[production mode](production_mode.md).

!!! warning "Available in Taipy Enterprise edition"

The production mode is relevant only to the Enterprise edition of Taipy.

## Versions

A *version* is basically made of a *mode* and a configuration (`Config^`). The various versions
Expand Down
4 changes: 4 additions & 0 deletions docs/manuals/userman/versioning/production_mode.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
!!! warning "Available in Taipy Enterprise edition"

This section is relevant only to the Enterprise edition of Taipy.

When running a Taipy Core application in *--production* mode, Taipy can access all entities
attached to the current version or another *production* version. It corresponds to the case where
the application is stable and running in a production environment.
Expand Down
2 changes: 2 additions & 0 deletions docs/release-notes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,8 @@ This is the list of changes to Taipy releases as they were published.
typo, the CLI will suggest the closest valid argument.
- The `Scenario.export()` and `taipy.export_scenario()` have been transfered from the Community
edition to the Enterprise edition as it is more suitable for enterprise applications.
- The production mode of the version management system has been transfered from the Community edition
to the Enterprise edition as it is more suitable for enterprise applications.
- Removed support for SQL repository. Taipy community edition now only supports the `filesystem`
repository type.

Expand Down
Loading