knife-ec-backup

KO | EN

gitlite — search

#python #hacktoberfest #golang #go #android #machine-learning #macos #windows #awesome #cli #security #pytorch #openai #open-source

knife-ec-backup

(★ 32)

Backup and restore Chef Infra Server in a repository-compatible format

knife-ec-backup 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Knife EC Backup
[![Build status](https://badge.buildkite.com/4bc85427aab66accafbd7abb2932b9dd7f9208162c5be33488.svg?branch=main)](https://buildkite.com/chef-oss/chef-knife-ec-backup-main-verify)
[![Gem Version](https://badge.fury.io/rb/knife-ec-backup.svg)](https://badge.fury.io/rb/knife-ec-backup)

## Description

knife-ec-backup can backup and restore the data in a Chef Infra
Server installation, preserving the data in an intermediate, editable
text format.  It is similar to the `knife download` and `knife upload`
commands and uses the same underlying libraries, but also includes
workarounds for objects not yet supported by those tools and various
Infra Server API deficiencies.  The long-run goal is to improve `knife
download`, `knife upload` and the Chef Infra Server API and deprecate this
tool.

## Requirements

This knife plugin requires Chef Infra Client 11.8+.

### Server Support

This plugin currently supports Chef Infra Server 12+.
Support for the beta key rotation features is provided via the
`--with-keys-sql` flag, but users of this feature should note that
this may change once the Chef Infra Server supports an API-based export of
the key data.

## Installation

### Chef Infra Server Install (Recommended)

This gem is installed with Chef Infra Server 12 and later and the sub-commands are available with embedded copy of `knife`, e.g.:

```
sudo /opt/opscode/bin/knife ec backup ~/chef-server-backup-directory
```

If you need a newer version of `knife-ec-backup` than is on the server you wish to back up, you can install it using the embedded `gem` command.

```
/opt/opscode/embedded/bin/gem install knife-ec-backup --no-doc
```

### Chef Workstation Install (Unsupported)

On systems other than the Chef Infra Server, installation of this gem is not
tested or supported. However, if you attempt to do so you will need the
postgresql libraries installed.

For example, on macOS:

```
brew install libpq
gem install knife-ec-backup -- --with-pg-config=/usr/local/Cellar/libpq/9.2/bin/pg_config
```

The current location of pg_config can be determined with `brew info libpq`.

## Running tests

```
$ bundle install
$ bundle exec rspec spec/
```

If bundle install fails on the pg gem and the note above does not work for you, try:

```
$ brew install postgres (if not present)
$ ARCHFLAGS="-arch x86_64" gem install pg
$ bundle exec rspec spec/
```

## Build from source

Clone the git repository and run the following from inside:

gem build knife-ec-backup.gemspec
    gem install knife-ec-backup*gem

## Configuration

### Permissions

Note that most users in a Chef Infra Server installation lack the permissions to pull all of the data from all organizations and other users.
This plugin **REQUIRES THE PIVOTAL KEY AND WEBUI KEY** from the Chef Infra Server.
It is recommended that you run this from a frontend Chef Infra Server. You can use `--user pivotal --key /path/to/pivotal.pem` to provide a path to the `pivotal` key.

## Subcommands

### Common Options

The following options are supported across all subcommands:

* `--sql-host`:
    The hostname of the Chef Infra Server's postgresql server. (default: localhost)

* `--sql-port`:
    The postgresql listening port on the Chef Infra Server. (default: 5432)

* `--sql-db`:
    The postgresql Chef Infra Server database name. (default: opscode_chef)
    Specify 'automate-cs-oc-erchef' when using Automate Chef Infra Server API

* `--sql-user`:
    The username of postgresql user with access to the opscode_chef
    database. (default: autoconfigured from
    /etc/opscode/chef-server-running.json)

* `--sql-password`:
    The password for the sql-user.  (default: autoconfigured from /etc/opscode/chef-server-running.json)

* `--purge`:
    Whether to sync deletions from backup source to restore destination. (default: false)

* `--dry-run`:
    Report what actions would be taken without performing any. (default: false)

* `--skip-frozen-cookbook-status`:
    Skip backing up and restoring cookbook frozen status. When this option is used, cookbook frozen status will not be preserved during backup/restore operations. (default: false)

### knife ec backup DEST_DIR (options)

*Path*: If you have Chef Infra Client installed on this server, you may need to invoke this as `/opt/opscode/bin/knife ec backup BACKUP_DIRECTORY`

*Options*

* `--concurrency THREAD_COUNT`:
    The maximum number of concurrent requests to make to the Chef
    Server. (default: 10)

* `--webui-key`:
    Used to set the path to the WebUI Key (default: /etc/opscode/webui_priv.pem)
    skip any auto-configured options (default: false)

* `--with-user-sql`:
    Whether to backup/restore user data directly from the database.  This
    requires access to the listening postgresql port on the Chef
    Server.  This is required to correctly handle user passwords and
    to ensure user-specific association groups are not duplicated.

* `--with-key-sql`: Whether to backup/restore key data directly
    from the database.  This requires access to the listening
    postgresql port on the Chef Infra Server.  This is required to correctly
    handle keys in Chef Infra Servers with multikey support. This option
    will only work on `restore` if it was also used during the
    `backup`.

* `--skip-useracl`:
    Skip download/restore of the user ACLs.  User ACLs are the
    permissions that actors have *on other global users*.  These are
    not the ACLs that control what permissions users have on various
    Chef objects.

* `--skip-version-check`:
    Skip Chef Infra Server version check. This will also skip any auto-configured options (default: false)

* `--only-org ORG`:
    Only donwload/restore objects in the named organization. Global
    objects such as users will still be downloaded/restored.

Creates a repository of an entire Chef Infra Server

The format of the repository is based on the `knife-essentials` (`knife download`) format and looks like this:

users
      <name>.json
    user_acls
      <name>.json
    organizations
      <orgname>
        acls
          <type>
            <name>.json
        clients
          <name>.json
        containers
          <name>.json
        cookbooks
          <name>-<version>
            status.json (contains frozen status information)
        data_bags
          <bag name>
            <item name>
        environments
          <name>.json
        groups
          <name>.json
        nodes
          <name>.json
        roles
          <name>.json
        org.json
        members.json
        invitations.json

This compares very closely with the "knife download /" from an OSC server:

clients
      <name>.json
    cookbooks
      <name>-<version>
    data_bags
      <bag name>
        <item name>
    environments
      <name>.json
    nodes
      <name>.json
    roles
      <name>.json
    users
      <name>.json>

### knife ec restore DEST_DIR (options)

Restores all data from the specified DEST_DIR to a Chef Infra Server. DEST_DIR should be a backup directory created by
`knife ec backup`

*Options*

* `--webui-key`:
    Used to set the path to the WebUI Key (default: /etc/opscode/webui_priv.pem)

* `--overwrite-pivotal`:
    Whether to overwrite pivotal's key.  Once this is done, future
    requests will fail until you fix the private key (default: false)

* `--skip-users`:
    Skip the restore of global users.  This may cause organization
    uploading to fail if the necessary users do not exist on the Chef
    Server.

* `--concurrency THREAD_COUNT`:
    The maximum number of concurrent requests to make to the Chef
    Server. (default: 10)

* `--skip-version-check`:
    Skip Chef Infra Server version check. This will
    also skip any auto-configured options (default: false)

* `--[no-]skip-user-ids`:
    Reuses user ids from the restore destination when updating existing
    users to avoid database conflicts (default: true)

* `--with-user-sql`:
    Whether to backup/restore user data directly from the database.  This
    requires access to the listening postgresql port on the Chef
    Server.  This is required to correctly handle user passwords and
    to ensure user-specific association groups are not
    duplicated. This option will only work on `restore` if it was also
    used during the `backup`.

* `--with-key-sql`: Whether to backup/restore key data directly
    from the database.  This requires access to the listening
    postgresql port on the Chef Infra Server.  This is required to correctly
    handle keys in Chef Infra Servers with multikey support. This option
    will only work on `restore` if it was also used during the
    `backup`.

* `--skip-useracl`:
    Skip download/restore of the user ACLs.  User ACLs are the
    permissions that actors have *on other global users*.  These are
    not the ACLs that control what permissions users have on various
    Chef objects.

* `--only-org ORG`:
    Only download/restore objects in the named organization. Global
    objects such as users will still be downloaded/restored.

* `--skip-frozen-cookbook-status`:
    Skip restoring cookbook frozen status. When this option is used, any `status.json` files in the backup will be ignored and cookbook frozen status will not be applied during restore. (default: false)

### knife ec import DIRECTORY (options)

Imports Chef objects (cookbooks, roles, nodes, etc.) into **existing** organizations from the specified DIRECTORY. This command is designed for environments where identity (users and organizations) is managed externally (e.g., by IAM in Chef 360 DSM).

Unlike `restore`, this command:
- Does **NOT** create users
- Does **NOT** create organizations (validates they exist)
- Does **NOT** import user passwords or keys
- Does **NOT** support direct database access (`--with-user-sql` / `--with-key-sql`)

*Options*

* `--concurrency THREAD_COUNT`:
    The maximum number of concurrent requests to make to the Chef
    Server. (default: 10)

* `--webui-key`:
    Used to set the path to the WebUI Key (default: /etc/opscode/webui_priv.pem)

* `--skip-useracl`:
    Skip restoring User ACLs.

* `--only-org ORG`:
    Only import objects in the named organization.

* `--skip-frozen-cookbook-status`:
    Skip restoring cookbook frozen status.

### knife ec key export [FILENAME]

Create a json representation of the users table from the Chef Infra Server
database.  If no argument is given, the name of the backup is
`key_dump.json`.

Please note, most users should use `knife ec backup` with the
`--with-user-sql` option rather than this command.

### knife ec key import [FILENAME]

Import a json representation of the users table from FILENAME to the
the Chef Infra Server database.  If no argument is given, the filename is
assumed to be `key_dump.json`.

Please note, most users should use `knife ec restore` with the
`--with-user-sql` option rather than this command.

## Cookbook Frozen Status

This plugin supports backing up and restoring cookbook frozen status. When a cookbook is frozen on the Chef Infra Server, this status is preserved during backup operations by creating a `status.json` file within each cookbook directory that contains the frozen state information.

During restore operations, the plugin will automatically restore the frozen status of cookbooks by reading the `status.json` files and applying the frozen state to the Chef Infra Server using the appropriate API calls.

### Skipping Frozen Status

If you want to skip backing up or restoring cookbook frozen status, you can use the `--skip-frozen-cookbook-status` option with both `knife ec backup` and `knife ec restore` commands. When this option is used:

- During backup: `status.json` files will not be created for cookbooks
- During restore: Any existing `status.json` files will be ignored and cookbook frozen status will not be applied

This can be useful when migrating between Chef Infra Server versions that may handle frozen cookbooks differently, or when you specifically want to unfreeze all cookbooks during the restore process.

## Known Bugs

- `knife ec restore` can fail to restore cookbooks, failing with an
  internal server error. A common cause of this problem is a
  concurrency bug in Chef Infra Server. Setting `--concurrency 1` can often
  work around the issue.

# Copyright

See [COPYRIGHT.md](./COPYRIGHT.md).

knife-ec-backup

knife-ec-backup 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

knife-ec-backup

knife-ec-backup 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README