Skip to content

Commit

Permalink
Minor updates to design.md , README.md (#217)
Browse files Browse the repository at this point in the history
* Update design.md
* Update README.md : bringing changes suggested in the pending PR #181
  • Loading branch information
cruizen committed Dec 16, 2022
1 parent 91d1f79 commit 25a1772
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ However, it does NOT remove the repository from `argocd`. When the "default" ali
we also clear the "default" entry from the JSON file.

#### Examples
Given below are some examples for registering an unregistering a repository.
Given below are some examples for registering and unregistering a repository.
##### Registering Repositories
Registering a repository requires the repository link, the GitHub username(`--user`), and a personal access token(`--password`).
When the `--password` flag isn't provided at the command line, the CLI will prompt for a password(this is the recommended approach).
Expand Down Expand Up @@ -168,7 +168,7 @@ the bundle at the time the cluster was created, and is not affected by subsequen
changes to the bundle's manifest data.

### Dynamic bundle
A dynamic bunlde contains a reference to the manifest data stored in git.
A dynamic bundle contains a reference to the manifest data stored in git.
A dynamic bundle is distinguished
by having these fields set to non-empty values:
- git URL of the repo
Expand Down Expand Up @@ -248,7 +248,7 @@ After this step, you should be logged in as `admin` and a config file was create
Example: `argocd repo add https://github.com/myname/arlon_workspace --username myname --password secret`.
- Note: type `argocd repo add --help` to see all available options.
- For Arlon developers, this is not your fork of the Arlon source code repository,
but a separate git repo where some artefacts like profiles created by Arlon will be stored.
but a separate git repo where some artifacts like profiles created by Arlon will be stored.
- Highly recommended: [configure a webhook](https://argo-cd.readthedocs.io/en/stable/operator-manual/webhook/)
to immediately notify ArgoCD of changes to the repo. This will be especially useful
during the tutorial. Without a webhook, repo changes may take up to 3 minutes
Expand Down
8 changes: 4 additions & 4 deletions docs/design.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@

This Kubernetes cluster hosts the following components:
- ArgoCD
- Arlo
- Arlon
- Cluster management stacks e.g. Cluster API and/or Crossplane

The Arlo state and controllers reside in the arlo namespace.
The Arlon state and controllers reside in the arlon namespace.

## Configuration bundle

Expand Down Expand Up @@ -60,14 +60,14 @@ It is composed of
If absent, the profile can only be applied to existing clusters.
- A list of bundles specifying the configuration to apply onto the cluster
once it is operational
- An optional list of `value.yaml` settings for any Helm Chart type bundle
- An optional list of `values.yaml` settings for any Helm Chart type bundle
in the bundle list

## Cluster chart

The cluster chart is a Helm chart that creates (and optionally applies) the
manifests necessary to create a cluster and deploy desired configurations
and applications to it. When a user uses Arlo to create and configure a cluster,
and applications to it. When a user uses Arlon to create and configure a cluster,
he or she specifies a profile. The profile's cluster specification, bundle
list and other settings are used to generate values for the chart, and the
chart is deployed as a Helm release into the *arlo* namespace in the
Expand Down

0 comments on commit 25a1772

Please sign in to comment.