configurationengine/doc/cli/export.rst
author m2lahtel
Tue, 10 Aug 2010 14:29:28 +0300
changeset 3 e7e0ae78773e
parent 0 2e8eeb919028
permissions -rw-r--r--
ConE 1.2.11 release
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     1
ConE export action
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     2
==================
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     3
Running action export
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     4
Usage: cone export [options]
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     5
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
     6
The export functionality exports configurations from the current project to a remote project. Default value for the current project is the currently working directory. A project can be either a folder or a CPF/ZIP file or even a Carbon webstorage (via ExtAPI).
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     7
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     8
Examples
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     9
--------
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    10
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    11
**Export a configuration from configuration project folder to a zip file**::
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    12
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    13
    >cd configproject_root
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    14
    >cone export -c configuration_root.confml --remote=exported.zip
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    15
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    16
or use the option -p|--project to point to the configuration project root::
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    17
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    18
    >cone export --project=configproject_root --remote=exported.zip -c configuration_root.confml
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    19
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    20
**Export a configuration from a zip|cpf file to a folder**
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    21
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    22
The different to the previous example is that the project parameters are turned otherway around. ::
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    23
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    24
    >cd configproject_root
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    25
    >cone export --project exported.zip --remote=. -c configuration_root.confml 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    26
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    27
**Export a configuration from a webstorage (carbon) file to a folder**
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    28
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    29
The Carbon functionality will be released in ConE 1.2 release and is not yet officially available. 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    30
The usage is similar to the previous, but the carbon path is given as http://serverpath/extapi.::
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    31
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    32
    >cd configproject_root
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    33
    >cone export --project http://carbonqa.nokia.com/extapi -r . -c configuration_root.confml 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    34
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    35
See the info action for getting a list of available configurations inside Carbon.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    36
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    37
**Export a configuration from a folder to webstorage (carbon)**::
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    38
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    39
    >cd configproject_root
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    40
    >cone export --remote http://carbonqa.nokia.com/extapi -c configuration_root.confml 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    41
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    42
**Export a configuration and run a action during the export**::
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    43
ConE can also run separate actions during the exporting for example to fix model level errors if possible. To run for example the fix step during export you can use --run-action=fix attribute.
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    44
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    45
    >cd configproject_root
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    46
    >cone export -c configuration_root.confml --remote=../export_folder --run-action=fix
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    47
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    48
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    49
Options list
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    50
------------
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    51
Options:
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    52
  --version             show program's version number and exit
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    53
  -h, --help            show this help message and exit
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    54
  --print-settings      Print all the default settings from the current
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    55
                        setting container.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    56
  --print-supported-impls
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    57
                        Print all supported ImplML XML namespaces and file
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    58
                        extensions.
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    59
  --print-runtime-info  Print runtime information about ConE.
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    60
  -v LEVEL, --verbose=LEVEL
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    61
                        Print error, warning and information on system out.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    62
                        Possible choices: Default is 3.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    63
                        NONE (all)    0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    64
                        CRITICAL      1
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    65
                        ERROR         2
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    66
                        WARNING       3
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    67
                        INFO          4
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    68
                        DEBUG         5
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    69
  --log-file=FILE       Location of the used log file. Default is 'cone.log'
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    70
  --log-config=FILE     Location of the used logging configuration file.
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    71
                        Default is 'logging.ini'
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    72
  --username=USERNAME   Username for webstorage operations. Not needed for
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    73
                        filestorage or cpf storage. If the username
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    74
                        is not given, the tool will use the logged in
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    75
                        username. Example: cone export -p webstorage_url -r .
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    76
                        -c sample.confml --username=admin --password=abc123.
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    77
  --password=PASSWORD   Password for webstorage operations. Not needed for
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    78
                        filestorage or cpf storage. If the password
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    79
                        is not given, the tool will prompt for password if
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    80
                        needed.
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    81
  -c CONFIG, --configuration=CONFIG
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    82
                        Defines the name of the configuration for the action,
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    83
                        can be specified multiple times to include multiple
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    84
                        configurations.
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    85
  --config-wildcard=WILDCARD
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    86
                        Wildcard pattern for including configurations, e.g.
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    87
                        product_langpack_*_root.confml
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    88
  --config-regex=REGEX  Regular expression for including configurations, e.g.
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    89
                        product_langpack_\d{2}_root.confml
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    90
  -p STORAGE, --project=STORAGE
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    91
                        defines the location of current project. Default is
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    92
                        the current working directory.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    93
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    94
  Export options:
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    95
    The export action is intended for exporting configurations from one
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    96
    project (storage) to another. A project can be a folder, a CPF or ZIP
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    97
    file, or a Carbon web storage URL.
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    98
    Two different ways of exporting are supported:
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    99
    1. Exporting multiple configurations into one new project using
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   100
    --remote
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   101
    2. Exporting configurations into a number of new projects using
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   102
    --export-dir
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   103
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   104
    -r STORAGE, --remote=STORAGE
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   105
                        Defines the location of remote storage. All
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   106
                        configurations included using --configuration,
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   107
                        --config-wildcard and --config-regex are exported into
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   108
                        the storage. If the remote storage location is not
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   109
                        given, the default location is determined based on the
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   110
                        first included source configuration name. E.g.
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   111
                        'example.confml' would be exported into 'example.cpf'
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   112
    --export-dir=EXPORT_DIR
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   113
                        Defines the directory where each included
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   114
                        configuration is exported as a new project.
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   115
    --export-format=EXPORT_FORMAT
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   116
                        Defines the format into which projects are exported
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   117
                        when using --export-dir. Possible values are 'cpf'
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   118
                        (the default) and 'dir'.
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   119
    -a CONFIG, --add=CONFIG
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   120
                        Adds a configuration layer to the given configuration
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   121
                        as last element. The add operation can be used several
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   122
                        times in a single command and it can create even an
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   123
                        empty layer. Example --add foo/root.confml --add bar
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   124
                        /root-confml.
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   125
    --run-action=PLUGIN
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   126
                        Adds a execution of extra step that can manipulate the
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   127
                        configuration before it is exported to external
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   128
                        storage. The --run-action operation can be used
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   129
                        several times in a single command and it will execute
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   130
                        the actions in given order.Example --run-action=fix,
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   131
                        which would execute fix action during export.
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   132
    --exclude-folders   Excludes empty folders from export