Home / icechunk-python / configuration
Configuration
When creating and opening Icechunk stores, there are a two different sets of configuration to be aware of:
StorageConfig
- for configuring access to the object store or filesystemStoreConfig
- for configuring the behavior of the Icechunk Store itself
Storage Config
Icechunk can be confirgured to work with a both object storage and filesystem backends. The storage configuration defines the location of an Icechunk store, along with any options or information needed to access data from a given storage type.
S3 Storage
When using Icechunk with s3 compatible storage systems, credentials must be provided to allow access to the data on the given endpoint. Icechunk allows for creating the storage config for s3 in three ways:
With this option, the credentials for connecting to S3 are detected automatically from your environment. This is usually the best choice if you are connecting from within an AWS environment (e.g. from EC2). See the API
With this option, you provide your credentials and other details explicitly. See the API
With this option, you connect to S3 anonymously (without credentials). This is suitable for public data. See the API
Filesystem Storage
Icechunk can also be used on a local filesystem by providing a path to the location of the store
Store Config
Separate from the storage config, the Store can also be configured with options which control its runtime behavior.
Writing chunks inline
Chunks can be written inline alongside the store metadata if the size of a given chunk falls within the configured threshold. Inlining allows these small chunks (often used to store small coordinate variables) to be accessed more quickly. This is the default behavior for chunks smaller than 512 bytes, but it can be overridden using the inline_chunk_threshold_bytes
option:
Virtual Reference Storage Config
Icechunk allows for reading "Virtual" data from existing archival datasets. This requires creating a distinct VirtualRefConfig
(similar to StorageConfig
) giving Icechunk the necessary permissions to access the archival data. This can be configured using the virtual_ref_config
option:
Creating and Opening Repos
Now we can now create or open an Icechunk store using our config.
Creating a new store
Note
Icechunk stores cannot be created in the same location where another store already exists.
Opening an existing store
storage = icechunk.StorageConfig.s3_anonymous(
bucket='earthmover-sample-data',
prefix='icechunk/oisst.2020-2024/',
region='us-east-1',
)
config = icechunk.StoreConfig(
virtual_ref_config=icechunk.VirtualRefConfig.s3_anonymous(region='us-east-1'),
)
store = icechunk.IcechunkStore.open_existing(
storage=storage,
mode="r+",
config=config,
)
Access Mode
Note that in all of the above examples, a mode
is provided to instruct the access level of the user to the store. This mode instructs whether the store should be opened in read only mode, and the store should start with a clean slate (although Icechunk prevents the possibility of accidentally overwriting any data that was previously comimtted to the store forever). For more about the access modes, see the zarr-python
docs.