blob: 7fbb398f369048a06786fef14e4a2981dc2c8b1c [file] [log] [blame]
Mohammed Nasera5467342024-04-30 00:34:16 -04001#################
2CSI Configuration
3#################
4
5This section details how to configure Container Storage Interfaces (CSI) for
6your Kubernetes cluster that Atmosphere runs on. You will need to follow the
7steps below to enable specific CSI drivers based on your storage requirements.
8
9********
10Ceph RBD
11********
12
13If you are using the Ceph storage solution that Atmosphere deploys out of the
14box, no additional configuration is required. The necessary settings are
15automatically applied during the installation process.
16
17***************
18Dell PowerStore
19***************
20
21For environments requiring the integration of PowerStore for storage,
22configure the PowerStore CSI driver by updating your Ansible inventory as
23follows:
24
25.. code-block:: yaml
26
27 csi_driver: powerstore
28 powerstore_csi_config:
29 arrays:
30 - endpoint: https://<FILL IN>/api/rest
31 globalID: <FILL IN>
32 username: <FILL IN>
33 password: <FILL IN>
34 skipCertificateValidation: true
35 isDefault: true
36 blockProtocol: <FILL IN> # FC or iSCSI
37
38Ensure that you replace ``<FILL IN>`` with actual values relevant to your
39PowerStore configuration. This includes specifying the block protocol, which
40can either be Fibre Channel (FC) or iSCSI, depending on your network
41infrastructure.
42
Mohammed Naseredeb56a2024-06-17 20:43:27 -040043*********
44IBM Block
45*********
46
47If you're using a storage array that is compatible with the IBM Block CSI
48driver, you can configure it by updating your Ansible inventory as follows:
49
50.. code-block:: yaml
51
52 csi_driver: ibm_block
53 ibm_block_csi_driver_management_address: <FILL IN>
54 ibm_block_csi_driver_username: <FILL IN>
55 ibm_block_csi_driver_password: <FILL IN>
56 ibm_block_csi_driver_pool: <FILL IN>
57 ibm_block_csi_driver_io_group: <FILL IN>
58
59Optionally, you can control the ``SpaceEfficiency`` setting which defaults to
60`thin` to enable thin provisioning. To change it to any other value, you
61can set the following variable:
62
63.. code-block:: yaml
64
65 ibm_block_csi_driver_space_efficiency: <FILL IN>
66
67Ensure that you replace ``<FILL IN>`` with actual values relevant to your IBM
68Block configuration. You can use the `Creating a StorageClass <https://www.ibm.com/docs/en/stg-block-csi-driver/1.11.3?topic=configuring-creating-storageclass>`_
69documentation to help you determine the values to use.
70
Mohammed Nasera5467342024-04-30 00:34:16 -040071********
72StorPool
73********
74
75For environments requiring the integration of StorPool for storage, configure
76the StorPool CSI driver by updating your Ansible inventory as follows:
77
78.. code-block:: yaml
79
80 csi_driver: storpool
81 storpool_csi_template: k8s
82
83The ``storpool_csi_template`` variable specifies the StorPool template to use
84for the deployment which is set to ``k8s`` in the example above.