Pure Storage FlashArray and FlashBlade JSON file
Portworx CSI uses a single secret for both FlashArray and FlashBlade configurations. If you plan to use both together, specify all your FlashBlade and FlashArray entries in a single JSON file.
pure.json
file structure
- Without CSI topology
- With CSI topology
{
"FlashArrays": [
{
"MgmtEndPoint": "<management-endpoint-of-first-fa>",
"APIToken": "<first-fa-api-token>",
"Realm": "<first-fa-realm>"
},
{
"MgmtEndPoint": "<management-endpoint-of-second-fa>",
"APIToken": "<second-fa-api-token>",
"Realm": "<first-fa-realm>"
}
],
"FlashBlades": [
{
"MgmtEndPoint": "<management-endpoint-of-first-fb>",
"APIToken": "<api-token-of-first-fb>",
"NFSEndPoint": "<nfs-endpoints-of-first-fb>"
},
{
"MgmtEndPoint": "<management-endpoint-of-second-fb>",
"APIToken": "<api-token-of-second-fb>",
"NFSEndPoint": "<nfs-endpoints-of-second-fb>"
}
]
}
{
"FlashArrays": [
{
"MgmtEndPoint": "<management-endpoint-of-first-fa>",
"APIToken": "<first-fa-api-token>",
"Realm": "<first-fa-realm>",
"Labels": {
"topology.portworx.io/zone": "zone-0",
"topology.portworx.io/region": "region-0"
}
},
{
"MgmtEndPoint": "<management-endpoint-of-second-fa>",
"APIToken": "<second-fa-api-token>",
"Realm": "<first-fa-realm>",
"Labels": {
"topology.portworx.io/zone": "zone-1",
"topology.portworx.io/region": "region-1"
}
}
],
"FlashBlades": [
{
"MgmtEndPoint": "<management-endpoint-of-first-fb>",
"APIToken": "<api-token-of-first-fb>",
"NFSEndPoint": "<nfs-endpoints-of-first-fb>",
"Labels": {
"topology.portworx.io/zone": "zone-0",
"topology.portworx.io/region": "region-0"
}
},
{
"MgmtEndPoint": "<management-endpoint-of-second-fb>",
"APIToken": "<api-token-of-second-fb>",
"NFSEndPoint": "<nfs-endpoints-of-second-fb>",
"Labels": {
"topology.portworx.io/zone": "zone-1",
"topology.portworx.io/region": "region-1"
}
}
]
}
For FlashArray, the Realm field in the above pure.json file is required only for Secure Multitenancy.
FlashArray object reference
Key | Value | Required? |
---|---|---|
MgmtEndPoint | Management endpoint of the FlashArray you want to use as backend storage for Kubernetes applications. Data type: string Format: Either an IP address or a fully qualified domain name (without a protocol). Note: For IPv6 addresses, ensure that the IP address is enclosed in square brackets, for example: | Yes |
APIToken | API token for the user account you want to use to perform storage operations on the FlashArray. Data type: string Format: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX | Yes |
Realm | Realms define the boundaries of a tenant. When multiple FlashArrays are attached to a cluster, the admin can specify the realm, and FlashArray volumes will be placed inside this realm. | Yes (only for secure multi-tenancy feature) |
Labels | When you enable CSI topology, you need to specify Labels that describe the topology for each FlashArray. The keys must match a set of specific strings, but you can define your own values. The following CSI topology Labels keys are available:
Note: If you are a PSO user, you can use topology.purestorage.com labels when you migrate from PSO to Portworx using the pso2px tool. | Yes (only for CSI topology feature) |
FlashBlade object reference
Key | Value | Required? |
---|---|---|
MgmtEndPoint | Management endpoint of the FlashBlade you want to use as backend storage for Kubernetes applications. Data type: string Format: Either an IP address or a fully qualified domain name (without a protocol). Note: For IPv6 address, ensure that the IP address is enclosed in square brackets, for example: | Yes |
APIToken | API token for the user account you want to use to perform storage operations on the FlashBlade. Data type: string Format: T-XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX | Yes |
NFSEndPoint | NFS endpoint of the FlashBlade. Data type: string Format: Either an IP address or a fully qualified domain name (without a protocol). Note: For IPv6 address, ensure that the IP address is enclosed in square brackets, for example: | Yes |
Labels | When you enable CSI topology, you need to specify Labels that describe the topology for each FlashBlade. The keys must match a set of specific strings, but you can define your own values. The following CSI topology Labels keys are available:
Note: f you are a PSO user, you can use topology.purestorage.com labels when you migrate from PSO to Portworx using the pso2px tool. | Yes (only for CSI topology feature) |