Skip to content

CRUD

create_secret(**kwargs)

Create a new Secret instance with the specified parameters.

Parameters:

Name Type Description Default
**kwargs dict

Keyword arguments.

 {}

Returns:

Type Description
Secret

An instance of the created secret.
Source code in digitalhub_core/entities/secrets/crud.py 
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
def create_secret(**kwargs) -> Secret:
    """
    Create a new Secret instance with the specified parameters.

    Parameters
    ----------
    **kwargs : dict
        Keyword arguments.

    Returns
    -------
    Secret
        An instance of the created secret.
    """
    return secret_from_parameters(**kwargs)

create_secret_from_dict(obj)

Create a new Secret instance from a dictionary.

Parameters:

Name Type Description Default
obj dict

Dictionary to create object from.

 required

Returns:

Type Description
Secret

Secret object.
Source code in digitalhub_core/entities/secrets/crud.py 
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
def create_secret_from_dict(obj: dict) -> Secret:
    """
    Create a new Secret instance from a dictionary.

    Parameters
    ----------
    obj : dict
        Dictionary to create object from.

    Returns
    -------
    Secret
        Secret object.
    """
    check_context(obj.get("project"))
    return secret_from_dict(obj)

delete_secret(identifier, project=None, entity_id=None, delete_all_versions=False, **kwargs)

Delete object from backend.

Parameters:

Name Type Description Default
identifier str

Entity key or name.

 required
project str

Project name.

 None
entity_id str

Entity ID.

 None
delete_all_versions bool

Delete all versions of the named entity. Use entity name instead of entity key as identifier.

 False
**kwargs dict

Parameters to pass to the API call.

 {}

Returns:

Type Description
dict

Response from backend.
Source code in digitalhub_core/entities/secrets/crud.py 
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
def delete_secret(
    identifier: str,
    project: str | None = None,
    entity_id: str | None = None,
    delete_all_versions: bool = False,
    **kwargs,
) -> dict:
    """
    Delete object from backend.

    Parameters
    ----------
    identifier : str
        Entity key or name.
    project : str
        Project name.
    entity_id : str
        Entity ID.
    delete_all_versions : bool
        Delete all versions of the named entity.
        Use entity name instead of entity key as identifier.
    **kwargs : dict
        Parameters to pass to the API call.

    Returns
    -------
    dict
        Response from backend.
    """
    return delete_entity_api_ctx(
        identifier=identifier,
        entity_type=ENTITY_TYPE,
        project=project,
        entity_id=entity_id,
        delete_all_versions=delete_all_versions,
        **kwargs,
    )

get_secret(identifier, project=None, entity_id=None, **kwargs)

Get object from backend.

Parameters:

Name Type Description Default
identifier str

Entity key or name.

 required
project str

Project name.

 None
entity_id str

Entity ID.

 None
**kwargs dict

Parameters to pass to the API call.

 {}

Returns:

Type Description
Secret

Object instance.
Source code in digitalhub_core/entities/secrets/crud.py 
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
def get_secret(
    identifier: str,
    project: str | None = None,
    entity_id: str | None = None,
    **kwargs,
) -> Secret:
    """
    Get object from backend.

    Parameters
    ----------
    identifier : str
        Entity key or name.
    project : str
        Project name.
    entity_id : str
        Entity ID.
    **kwargs : dict
        Parameters to pass to the API call.

    Returns
    -------
    Secret
        Object instance.
    """
    obj = read_entity_api_ctx(
        identifier,
        ENTITY_TYPE,
        project=project,
        entity_id=entity_id,
        **kwargs,
    )
    return secret_from_dict(obj)

get_secret_versions(identifier, project=None, **kwargs)

Get object versions from backend.

Parameters:

Name Type Description Default
identifier str

Entity key or name.

 required
project str

Project name.

 None
**kwargs dict

Parameters to pass to the API call.

 {}

Returns:

Type Description
list[Secret]

List of object instances.
Source code in digitalhub_core/entities/secrets/crud.py 
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
def get_secret_versions(
    identifier: str,
    project: str | None = None,
    **kwargs,
) -> list[Secret]:
    """
    Get object versions from backend.

    Parameters
    ----------
    identifier : str
        Entity key or name.
    project : str
        Project name.
    **kwargs : dict
        Parameters to pass to the API call.

    Returns
    -------
    list[Secret]
        List of object instances.
    """
    obj = read_entity_api_ctx_versions(
        identifier,
        entity_type=ENTITY_TYPE,
        project=project,
        **kwargs,
    )
    return [secret_from_dict(o) for o in obj]

import_secret(file)

Import an Secret object from a file using the specified file path.

Parameters:

Name Type Description Default
file str

Path to the file.

 required

Returns:

Type Description
Secret

Object instance.
Source code in digitalhub_core/entities/secrets/crud.py 
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
def import_secret(file: str) -> Secret:
    """
    Import an Secret object from a file using the specified file path.

    Parameters
    ----------
    file : str
        Path to the file.

    Returns
    -------
    Secret
        Object instance.
    """
    obj: dict = read_yaml(file)
    return create_secret_from_dict(obj)

list_secrets(project, **kwargs)

List all objects from backend.

Parameters:

Name Type Description Default
project str

Project name.

 required
**kwargs dict

Parameters to pass to the API call.

 {}

Returns:

Type Description
list[Secret]

List of secrets.
Source code in digitalhub_core/entities/secrets/crud.py 
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
def list_secrets(project: str, **kwargs) -> list[Secret]:
    """
    List all objects from backend.

    Parameters
    ----------
    project : str
        Project name.
    **kwargs : dict
        Parameters to pass to the API call.

    Returns
    -------
    list[Secret]
        List of secrets.
    """
    objs = list_entity_api_ctx(
        project=project,
        entity_type=ENTITY_TYPE,
        **kwargs,
    )
    return [secret_from_dict(obj) for obj in objs]

new_secret(project, name, uuid=None, description=None, git_source=None, labels=None, embedded=True, secret_value=None, **kwargs)

Create a new Secret instance with the specified parameters.

Parameters:

Name Type Description Default
project str

Project name.

 required
name str

Object name.

 required
uuid str

ID of the object (UUID4).

 None
description str

Description of the object (human readable).

 None
git_source str

Remote git source for object.

 None
labels list[str]

List of labels.

 None
embedded bool

Flag to determine if object must be embedded in project.

 True
secret_value str

Value of the secret.

 None
**kwargs dict

Spec keyword arguments.

 {}

Returns:

Type Description
Secret

An instance of the created secret.
Source code in digitalhub_core/entities/secrets/crud.py 
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
def new_secret(
    project: str,
    name: str,
    uuid: str | None = None,
    description: str | None = None,
    git_source: str | None = None,
    labels: list[str] | None = None,
    embedded: bool = True,
    secret_value: str | None = None,
    **kwargs,
) -> Secret:
    """
    Create a new Secret instance with the specified parameters.

    Parameters
    ----------
    project : str
        Project name.
    name : str
        Object name.
    uuid : str
        ID of the object (UUID4).
    description : str
        Description of the object (human readable).
    git_source : str
        Remote git source for object.
    labels : list[str]
        List of labels.
    embedded : bool
        Flag to determine if object must be embedded in project.
    secret_value : str
        Value of the secret.
    **kwargs : dict
        Spec keyword arguments.

    Returns
    -------
    Secret
        An instance of the created secret.
    """
    if secret_value is None:
        raise ValueError("secret_value must be provided.")

    obj = create_secret(
        project=project,
        name=name,
        kind="secret",
        uuid=uuid,
        description=description,
        git_source=git_source,
        labels=labels,
        embedded=embedded,
        **kwargs,
    )
    obj.save()
    obj.set_secret_value(value=secret_value)
    return obj

update_secret(entity, **kwargs)

Update object in backend.

Parameters:

Name Type Description Default
entity Secret

The object to update.

 required
**kwargs dict

Parameters to pass to the API call.

 {}

Returns:

Type Description
Secret

Entity updated.
Source code in digitalhub_core/entities/secrets/crud.py 
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
def update_secret(entity: Secret, **kwargs) -> Secret:
    """
    Update object in backend.

    Parameters
    ----------
    entity : Secret
        The object to update.
    **kwargs : dict
        Parameters to pass to the API call.

    Returns
    -------
    Secret
        Entity updated.
    """
    obj = update_entity_api_ctx(
        project=entity.project,
        entity_type=ENTITY_TYPE,
        entity_id=entity.id,
        entity_dict=entity.to_dict(),
        **kwargs,
    )
    return secret_from_dict(obj)