> For the complete CircleCI developer hub index, see [llms.txt](https://circleci.com/developer/llms.txt)

# ionir-cloud/ionir

This Orb allows CircleCI users to utilize ionir Kubernetes Native Storage functionality including: - PVC cloning - Cloning back to time in 1s granularity - Teleport between clusters


## Commands

### clone

This command clones a pvc in a given cluster in real-time


| Parameter | Type | Default | Description |
|---|---|---|---|
| `clusterId` | string |  | Ionir cluster ID to run the command |
| `clusterUrl` | string |  | Ionir cluster URL to run the command (without https) |
| `destinationHistoryPolicy` | string | default | History Policy for the clones volume |
| `destinationNamespace` | string |  | Namespace for the clones volume |
| `destinationPvcName` | string |  | PVC name for the cloned volume |
| `sourceNamespace` | string |  | Namespace of the source PVC |
| `sourceTimeTag` | string |  | Timetag of the source PVC to be cloned (2019-10-12T07:20:50.52Z) |
| `sourceVolumeId` | string |  | Source PVC Ionir ID |

### teleport

This command clones a pvc to a remote k8s cluster in 40s


| Parameter | Type | Default | Description |
|---|---|---|---|
| `clusterId` | string |  | Ionir source cluster ID |
| `clusterUrl` | string | localhost | Ionir cluster URL to run the command (without https) |
| `destinationHistoryPolicy` | string | default | History Policy for the clones volume |
| `destinationNamespace` | string |  | Namespace for the clones volume |
| `destinationPvcName` | string |  | PVC name for the cloned volume |
| `destinationStorageClass` | string | ionir-default | StorageClass of the target PVC |
| `sourceVolumeId` | string |  | Source PVC Ionir ID |
| `teleClusterId` | string |  | Ionir cluster ID to pull the volume to from the source (target) |

## Examples

### clone

Sample example description.


```yaml
version: '2.1'
orbs:
  ionir: circleci/ionir@x.y
workflows:
  call-ionir:
    jobs:
      - ionir/clone
```