Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Image registry user guide #228

Merged
merged 1 commit into from
Sep 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions website/versioned_docs/version-3.0.0/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ title: Glossary
sidebar_label: Glossary
---

:::note
Pleas note that Litmus 3.0 is not backward compatible and will require a fresh installation for users looking to migrate from previous versions
:::

## Chaos Resources

At the heart of the Litmus Platform are the chaos custom resources. This section consists of the specification (details of each field within the .spec & .status of the resources) as well as standard examples for tuning the supported parameters.
Expand Down
30 changes: 15 additions & 15 deletions website/versioned_docs/version-3.0.0/user-guides/image-registry.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,45 @@
---
id: image-registry
title: Using different Image Registries in a Chaos Scenario
title: Using different Image Registries in a Chaos Experiments
sidebar_label: Using different Image Registries
---

---

A container image registry can be defined as a collection of repositories that store container image.
These can be either public or private. Few of the container image registries are Docker, Red Hat Quay, Google Container Registry.
By default LitmusChaos uses DockerHub for managing the different images. These images are then used in Chaos Scenarios. Few images that are used in the Litmus chaos scenarios are `litmuschaos:k8s`, `litmuschaos:litmus-checker` etc.
With ChaosCenter, you get the privilege to use your own/custom image registries for Chaos Scenarios.
By default LitmusChaos uses DockerHub for managing the different images. These images are then used in Chaos experiments. Few images that are used in the Litmus chaos experiments are `litmuschaos:k8s`, `litmuschaos:litmus-checker` etc.
With ChaosCenter, you get the privilege to use your own/custom image registries for Chaos experiments.

## Before you begin

To understand the concept of Image Registry, make sure you are aware of [Chaos Scenario](../concepts/chaos-workflow.md) and the different image registries that are used in it.
To understand the concept of Image Registry, make sure you are aware of [Chaos experiment](../concepts/chaos-workflow.md) and the different image registries that are used in it.

## Steps to Update Chaos Scenario Image Registry
## Steps to Update Chaos experiment Image Registry

To updated the Chaos Scenario Image Registry, you can go to Settings in ChaosCenter. In settings, there will be tab named Image Registry. On clicking the Image Registry tab, you can see that the default Registry server is `docker.io`, Registry name is `litmuschaos` and it is a Public registry.
To updated the Chaos experiment Image Registry, you can go to Image Registry in ChaosCenter (Project Setup > Image Registry on the left nav). On clicking the Image Registry tab, you can see that the default Registry server is `docker.io`, Registry name is `litmuschaos` and it is a Public registry.

<img src={require('../assets/user-guides/image-registry/img-registry-tab.png').default} width="800" />
<img src={require('../assets/user-guides/image-registry/img-registry-tab.png').default} />
<br/><br/>

To update this, click on the `Use Custom Values` option and provide the following details:

1. Registry Server
2. Registry Name
1. Custom Image Registry (Registry Server)
2. Custom Repo (Registry Name)
3. Registry Type `Public/Private`

<img src={require('../assets/user-guides/image-registry/img-registry-update.png').default} width="800" />
<img src={require('../assets/user-guides/image-registry/img-registry-update.png').default} />
<br/><br/>

If the Registry Type is `Private`, make sure to provide the secret and the namespace where the secret is present.
If the Registry Type is `Private`, make sure to provide the secret.

Once the details are provided, click on the `Save Changes` button and you can see the updated Image Registry changes.
Once the details are provided, click on the `Save` button and you can see the updated Image Registry changes.

<img src={require('../assets/user-guides/image-registry/img-registry-updated.png').default} width="800" />
<img src={require('../assets/user-guides/image-registry/img-registry-updated.png').default} />

<br/><br/>

Now while scheduling a chaos scenario, the image registry changes will be visible. Here's the code snippet from a Chaos Scenario after the image registry change.
Now while scheduling a chaos experiment, the image registry changes will be visible. Here's the code snippet from a Chaos experiment after the image registry change.

```yaml
- name: install-application
Expand All @@ -59,5 +59,5 @@ Now while scheduling a chaos scenario, the image registry changes will be visibl

## Learn More

- [What is a Chaos Scenario](../concepts/chaos-workflow.md)
- [What is a Chaos experiment](../concepts/chaos-workflow.md)
- [What is ChaosCenter](../getting-started/resources.md#chaoscenter)
3 changes: 1 addition & 2 deletions website/versioned_sidebars/version-3.0.0-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,7 @@
},
"user-guides/gitops-configuration",
"user-guides/image-registry",
"user-guides/uninstall-litmus",
"user-guides/upgrade"
"user-guides/uninstall-litmus"
]
},
{
Expand Down
Loading