Secrets on the Docker server.
| 25 | |
| 26 | |
| 27 | class SecretCollection(Collection): |
| 28 | """Secrets on the Docker server.""" |
| 29 | model = Secret |
| 30 | |
| 31 | def create(self, **kwargs): |
| 32 | obj = self.client.api.create_secret(**kwargs) |
| 33 | obj.setdefault("Spec", {})["Name"] = kwargs.get("name") |
| 34 | return self.prepare_model(obj) |
| 35 | create.__doc__ = APIClient.create_secret.__doc__ |
| 36 | |
| 37 | def get(self, secret_id): |
| 38 | """ |
| 39 | Get a secret. |
| 40 | |
| 41 | Args: |
| 42 | secret_id (str): Secret ID. |
| 43 | |
| 44 | Returns: |
| 45 | (:py:class:`Secret`): The secret. |
| 46 | |
| 47 | Raises: |
| 48 | :py:class:`docker.errors.NotFound` |
| 49 | If the secret does not exist. |
| 50 | :py:class:`docker.errors.APIError` |
| 51 | If the server returns an error. |
| 52 | """ |
| 53 | return self.prepare_model(self.client.api.inspect_secret(secret_id)) |
| 54 | |
| 55 | def list(self, **kwargs): |
| 56 | """ |
| 57 | List secrets. Similar to the ``docker secret ls`` command. |
| 58 | |
| 59 | Args: |
| 60 | filters (dict): Server-side list filtering options. |
| 61 | |
| 62 | Returns: |
| 63 | (list of :py:class:`Secret`): The secrets. |
| 64 | |
| 65 | Raises: |
| 66 | :py:class:`docker.errors.APIError` |
| 67 | If the server returns an error. |
| 68 | """ |
| 69 | resp = self.client.api.secrets(**kwargs) |
| 70 | return [self.prepare_model(obj) for obj in resp] |