Skip to content

Commit

Permalink
use
Browse files Browse the repository at this point in the history 
usage: kopia [<flags>] <command> [<args> ...]
Kopia - Fast And Secure Open-Source Backup

Flags:
      --[no-]help             Show context-sensitive help (also try --help-long
                              and --help-man).
      --[no-]version          Show application version.
      --log-file=LOG-FILE     Override log file.
      --log-dir="/home/amruta/.cache/kopia"
                              Directory where log files should be written.
                              ($KOPIA_LOG_DIR)
      --log-level=info        Console log level
      --file-log-level=debug  File log level
      --[no-]help-full        Show help for all commands, including hidden
      --config-file="repository.config"
                              Specify the config file to use
                              ($KOPIA_CONFIG_PATH)
  -p, --password=PASSWORD     Repository password. ($KOPIA_PASSWORD)
      --[no-]persist-credentials
                              Persist credentials
                              ($KOPIA_PERSIST_CREDENTIALS_ON_CONNECT)
      --[no-]use-keyring      Use Gnome Keyring for storing repository password.
                              ($KOPIA_USE_KEYRING)

Commands (use --help-full to list all commands):

  help [<command>...]
  benchmark
    compression --data-file=DATA-FILE [<flags>]
    crypto [<flags>]
    splitter [<flags>]
    hashing [<flags>]
    encryption [<flags>]
    ecc [<flags>]
  diff [<flags>] <object-path1> <object-path2>
  list [<flags>] <object-path>
  server
    start [<flags>]
    acl
      add --user=USER --target=TARGET --access=ACCESS
      delete [<flags>] [<id>...]
      enable [<flags>]
      list [<flags>]
    users
      add [<flags>] <username>
      set [<flags>] <username>
      delete <username>
      info <username>
      list [<flags>]
    status [<flags>]
    refresh [<flags>]
    flush [<flags>]
    shutdown [<flags>]
    snapshot [<flags>] [<source>]
    cancel [<flags>] [<source>]
    pause [<flags>] [<source>]
    resume [<flags>] [<source>]
    throttle
      get [<flags>]
      set [<flags>]
  restore [<flags>] <sources>...
  show <object-path>
  snapshot
    copy-history [<flags>] <source> [<destination>]
    move-history [<flags>] <source> [<destination>]
    create [<flags>] [<source>...]
    delete [<flags>] <id>...
    estimate [<flags>] <source>
    expire [<flags>] [<path>...]
    fix
      invalid-files [<flags>]
      remove-files [<flags>]
    list [<flags>] [<source>]
    migrate --source-config=SOURCE-CONFIG [<flags>]
    pin [<flags>] <id>...
    restore [<flags>] <sources>...
    verify [<flags>]
  policy
    edit [<flags>] [<target>...]
    list [<flags>]
    delete [<flags>] [<target>...]
    set [<flags>] [<target>...]
    show [<flags>] [<target>...]
  mount [<flags>] [<path>] [<mountPoint>]
  repository
    connect [<flags>]
      server --url=URL [<flags>]
      from-config [<flags>]
      azure --container=CONTAINER --storage-account=STORAGE-ACCOUNT [<flags>]
      b2 --bucket=BUCKET --key-id=KEY-ID --key=KEY [<flags>]
      filesystem --path=PATH [<flags>]
      gcs --bucket=BUCKET [<flags>]
      gdrive --folder-id=FOLDER-ID [<flags>]
      rclone --remote-path=REMOTE-PATH [<flags>]
      s3 --bucket=BUCKET --access-key=ACCESS-KEY --secret-access-key=SECRET-ACCESS-KEY [<flags>]
      sftp --path=PATH --host=HOST --username=USERNAME [<flags>]
      webdav --url=URL [<flags>]
    create [<flags>]
      azure --container=CONTAINER --storage-account=STORAGE-ACCOUNT [<flags>]
      b2 --bucket=BUCKET --key-id=KEY-ID --key=KEY [<flags>]
      filesystem --path=PATH [<flags>]
      gcs --bucket=BUCKET [<flags>]
      gdrive --folder-id=FOLDER-ID [<flags>]
      rclone --remote-path=REMOTE-PATH [<flags>]
      s3 --bucket=BUCKET --access-key=ACCESS-KEY --secret-access-key=SECRET-ACCESS-KEY [<flags>]
      sftp --path=PATH --host=HOST --username=USERNAME [<flags>]
      webdav --url=URL [<flags>]
    disconnect
    repair [<flags>]
      from-config [<flags>]
      azure --container=CONTAINER --storage-account=STORAGE-ACCOUNT [<flags>]
      b2 --bucket=BUCKET --key-id=KEY-ID --key=KEY [<flags>]
      filesystem --path=PATH [<flags>]
      gcs --bucket=BUCKET [<flags>]
      gdrive --folder-id=FOLDER-ID [<flags>]
      rclone --remote-path=REMOTE-PATH [<flags>]
      s3 --bucket=BUCKET --access-key=ACCESS-KEY --secret-access-key=SECRET-ACCESS-KEY [<flags>]
      sftp --path=PATH --host=HOST --username=USERNAME [<flags>]
      webdav --url=URL [<flags>]
    set-client [<flags>]
    set-parameters [<flags>]
    status [<flags>]
    sync-to [<flags>]
      from-config [<flags>]
      azure --container=CONTAINER --storage-account=STORAGE-ACCOUNT [<flags>]
      b2 --bucket=BUCKET --key-id=KEY-ID --key=KEY [<flags>]
      filesystem --path=PATH [<flags>]
      gcs --bucket=BUCKET [<flags>]
      gdrive --folder-id=FOLDER-ID [<flags>]
      rclone --remote-path=REMOTE-PATH [<flags>]
      s3 --bucket=BUCKET --access-key=ACCESS-KEY --secret-access-key=SECRET-ACCESS-KEY [<flags>]
      sftp --path=PATH --host=HOST --username=USERNAME [<flags>]
      webdav --url=URL [<flags>]
    throttle
      get [<flags>]
      set [<flags>]
    change-password [<flags>]
    validate-provider [<flags>] when referring to CLI whereas  for project/tool
  • Loading branch information
@kale-amruta
kale-amruta committed Aug 3, 2023
1 parent 7d10bbe commit 2f7f253
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 29 deletions.
48 changes: 24 additions & 24 deletions docs/architecture.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,11 @@ repository. Due to this a separate instance of the server will be used for each
repository.

In Kanister, the server will comprise a Kubernetes Pod, Service. The pod runs the
kopia repository server process that will be used by kopia clients to perform
Kopia repository server process that will be used by Kopia clients to perform
backup and restore. Kopia clients would only need a username/password and
service name to connect to server without the need to know the backend storage
location. This provides enhanced security since only authorized users will be
allowed to access the kopia repository server. These authorized users need to be
allowed to access the Kopia repository server. These authorized users need to be
added to the server before starting the server.

Kopia Repository
Expand All @@ -52,7 +52,7 @@ the repository requires the storage location and credential information similar
to a Kanister Profile CR and a unique password used by Kopia during encryption,
along with a unique path prefix mentioned above.

To know more about the design of kopia repository server controller refer
To know more about the design of Kopia repository server controller refer
its `design documentation <https://github.com/kanisterio/kanister/blob/master/design/kanister-kopia-integration.md>` _

The design of Kanister follows the operator pattern. This means
Expand Down Expand Up @@ -420,8 +420,8 @@ RepositoryServers
-----------------

RepositoryServer CR is required by kanister controller to start
a kopia repository server. The CR has list of parameters to configure
kopia repository server.
a Kopia repository server. The CR has list of parameters to configure
Kopia repository server.

.. note::
Secrets referenced in the CR should be created in the format referenced
Expand Down Expand Up @@ -453,7 +453,7 @@ The definition of ``Repository Server`` is:
}
- ``Storage`` field in the ``RepositoryServerSpec`` contains the location
details where the kopia repository is created
details where the Kopia repository is created

.. code-block:: go
:linenos:
Expand All @@ -466,7 +466,7 @@ The definition of ``Repository Server`` is:
^ ``SecretRef`` and ``CredentialSecretRef`` are the references to location
secrets

- ``Repository`` field in CR ``spec`` has details to connect to kopia repository created
- ``Repository`` field in CR ``spec`` has details to connect to Kopia repository created
in the above location storage

.. code-block:: go
Expand All @@ -481,25 +481,25 @@ The definition of ``Repository Server`` is:
}
^ ``RootPath`` is the path for the kopia repository. It is the sub-path within
^ ``RootPath`` is the path for the Kopia repository. It is the sub-path within
the path prefix specified in storage location
^ ``Username`` is an optional field used to override the default username while
connecting to kopia repository
connecting to Kopia repository
^ ``Hostname`` is an optional field used to override the default host name while
connecting to kopia repository
connecting to Kopia repository

Kopia identifies users by ``username@hostname`` and uses the values
specified when establishing connection to the repository to identify
backups created in the session.


^ ``PasswordSecretRef`` is the reference to the secret containing password to
connect to kopia repository
connect to Kopia repository
^ ``CacheSizeSettings`` is an optional field used to specify size of the different
caches for the kopia repository. If not specified, default cache settings are used
caches for the Kopia repository. If not specified, default cache settings are used
by repository server controller

To know more about the kopia caches, refer to the `kopia caching documentation <https://kubernetes.io/docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions/>`_`
To know more about the Kopia caches, refer to the `Kopia caching documentation <https://kubernetes.io/docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions/>`_`

.. code-block:: go
:linenos:
Expand All @@ -510,7 +510,7 @@ To know more about the kopia caches, refer to the `kopia caching documentation <
}
- ``Server`` field in the CR spec has references to all the secrets
required to start the kopia repository server
required to start the Kopia repository server

.. code-block:: go
:linenos:
Expand All @@ -522,12 +522,12 @@ To know more about the kopia caches, refer to the `kopia caching documentation <
}
^ ``AdminSecretRef`` is a secret reference containing admin credentials
required to start the kopia repository server
required to start the Kopia repository server

^ ``TLSSecretRef`` is a TLS secret reference for kopia client and server communication
^ ``TLSSecretRef`` is a TLS secret reference for Kopia client and server communication

^ ``UserAccess`` contains username and password secret reference required
for creating kopia repository server users.
for creating Kopia repository server users.

.. code-block:: go
:linenos:
Expand Down Expand Up @@ -571,7 +571,7 @@ To know more about the kopia caches, refer to the `kopia caching documentation <
ServiceName string `json:"serviceName,omitempty"`
}
^ ``PodName`` is the name of pod created by controller for kopia repository server
^ ``PodName`` is the name of pod created by controller for Kopia repository server

^ ``ServiceName`` is the name of the Kubernetes service created by the controller
which contains the connection details for repository server
Expand Down Expand Up @@ -620,14 +620,14 @@ As a reference, below is an example of a Repository Server
Repository Server Secrets
=========================

Kanister controller needs the following secrets to be created for starting the kopia
Kanister controller needs the following secrets to be created for starting the Kopia
repository server successfully. The secrets are referenced in the ``RepositoryServer``
CR as described in :ref:`RepositoryServer<repository_servers>`

Location Storage Secret
-----------------------

This secret stores the sensitive details of the location where the kopia
This secret stores the sensitive details of the location where the Kopia
repository is created. This secret is referenced by ``spec.storage.secretRef``
field in repository server CR

Expand Down Expand Up @@ -727,7 +727,7 @@ CR
Repository Password Secret
--------------------------
This is the password secret used by controller to connect to kopia repository. It
This is the password secret used by controller to connect to Kopia repository. It
is referenced by ``spec.repository.passwordSecretRef`` in repository server CR

.. code-block:: yaml
Expand All @@ -745,7 +745,7 @@ is referenced by ``spec.repository.passwordSecretRef`` in repository server CR
Repository Server Admin User Secret
-----------------------------------
This secret is used for storing admin credentials used by the controller
to start the kopia repository server. It is referenced by ``spec.server.accessSecretRef``
to start the Kopia repository server. It is referenced by ``spec.server.accessSecretRef``
in repository server CR

.. code-block:: yaml
Expand All @@ -765,7 +765,7 @@ in repository server CR
TLS Secret
----------

This secret store TLS sensitive data used for kopia client server communication.
This secret store TLS sensitive data used for Kopia client server communication.
It is in standard ``kubernetes.io/tls`` format. It is referenced by
``spec.server.tlsSecretRef`` in repository server CR

Expand All @@ -788,7 +788,7 @@ It is in standard ``kubernetes.io/tls`` format. It is referenced by
Repository Server User Access Password Secret
---------------------------------------------
The Kopia repository client needs an access username and password for authentication to
connect to kopia repository server
connect to Kopia repository server

Kopia client needs user in the format ``<username>@<hostname>`` . The username is same
for all the clients which is specified in ``spec.server.UserAccess.username`` of
Expand Down
10 changes: 5 additions & 5 deletions docs/tutorials/tutorial_with_repositoryserver.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Using Kopia Repository Server as Data Mover in Blueprint
********************************************************

This tutorial will demonstrate the use of Kopia to copy/restore backups
to a kopia repository. We will be using kanister functions
to a Kopia repository. We will be using kanister functions
that use Kopia repository Server as data mover in the blueprint.
For additional documentation on kanister functions and blueprints
refer to the :ref:`architecture` and :ref:`kanister functions<functions>`
Expand Down Expand Up @@ -87,7 +87,7 @@ Starting Kopia Repository Server
================================

To copy or restore backups to the location storage using the Kopia data mover,
it is necessary to start the Kopia repository server. To learn more about kopia
it is necessary to start the Kopia repository server. To learn more about Kopia
repository server, refer to :ref:`architecture <architecture>`.

The repository server controller requires the creation of a Repository Server
Expand Down Expand Up @@ -116,7 +116,7 @@ You can create it as shown below:
--secret-access-key=<SECRET_ACCESS_KEY>
To learn more about how to create repository and gain further insight into the Kopia
repository refer to `kopia documentation <https://kopia.io/docs/reference/command-line/>`_
repository refer to `Kopia documentation <https://kopia.io/docs/reference/command-line/>`_


Creating Secrets
Expand Down Expand Up @@ -346,10 +346,10 @@ and ``restore``. The ``backup`` action comprises of a single phase named as
``backupToS3``.

``backupToS3`` invokes the Kanister function ``BackupDataUsingKopiaServer``
that uses kopia repository server to copy backup data to s3 storage. The action
that uses Kopia repository server to copy backup data to s3 storage. The action
``restore`` uses two kanister functions ``ScaleWorkload`` and ``RestoreDataUsingKopiaServer``.
``ScaleWorkload`` function scales down the ``timelog`` application before restoring the data.
``RestoreDataUsingKopiaServer`` restores data using kopia repository server form
``RestoreDataUsingKopiaServer`` restores data using Kopia repository server form
s3 storage.

To learn more about the Kanister function, refer to the documentation on
Expand Down

0 comments on commit 2f7f253

Please sign in to comment.