Skip to content

Commit

Permalink
Update Readme and documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Vazquez,Brais (IT EDP) committed Mar 27, 2024
1 parent 1ec2796 commit 414c11a
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/modules/nexus/pages/administration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ chmod +x repos.sh
./repos.sh --git-ref $GIT_REF --repos="ods-core,ods-configuration" --source-project https://$BITBUCKET_HOST/scm/$BITBUCKET_PROJECT
----

The script can also be used in an umbrella directory in which the repositories already exist. Once the repositories are at the desired revision, change `NEXUS_FROM_IMAGE` in `ods-configuration/ods-core.env` to your desired image tag. Commit the change and push it to Bitbucket.
The script can also be used in an umbrella directory in which the repositories already exist. Once the repositories are at the desired revision, change `NEXUS_IMAGE_TAG` in `ods-configuration/ods-core.env` to your desired image tag. Commit the change and push it to Bitbucket.

Next, you should ensure that the Nexus `BuildConfig` resource in the central ODS namespace is up-to-date, then trigger a new build so that a new image with the changed base image gets built. Finally, a new deployment should be rolled out which uses the newly built image. All of this can be done from the `ods-core` repository:

Expand All @@ -40,6 +40,6 @@ Next, you should ensure that the Nexus `BuildConfig` resource in the central ODS
make install-nexus
----

This target depends on the targets `apply-nexus-build`, `start-nexus-build`, and `apply-nexus-deploy` which execute the steps described above (and can of course also be executed individually).
This target depends on the targets `apply-nexus-chart` and `start-nexus-build` which execute the steps described above (and can of course also be executed individually).

WARNING: There is also a `configure-nexus` target. However, this is not executed as part of `install-nexus` as it is not idempotent yet (which means it cannot be used against an existing Nexus deployment). For a simple Nexus version update, you don't need to change any configuration, but if you switch between ODS versions you should keep an eye on Nexus configuration.
22 changes: 20 additions & 2 deletions nexus/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,26 @@

Nexus is a repository manager. It allows you to proxy, collect, and manage your dependencies so that you are not constantly juggling a collection of artifacts. In essence. it makes it easy to distribute your software.

# Setup
## Setup

The OpenShift templates are located in `ocp-config` and can be compared with the OC cluster using [tailor](https://github.com/opendevstack/tailor). For example, run `cd oc-config && tailor status -l app=nexus -n ods` to see if there is any drift between current and desired state.
The OpenShift templates are located in `chart` and can be compared with the OC cluster using [Helm](https://github.com/helm/helm). For example, run `cd chart && helm secrets diff upgrade` to see if there is any drift between current and desired state.

To install Nexus, run `make install-nexus`.

## Administration

There is an `admin` user which is allowed to change settings, install plugins, etc. The password is located in the OC project `ods`, under the `nexus-app` secrets.

## Building a new image

Push to this repository, then go to the build config in OC and start a new build.

Aditionally you can run `make start-nexus-build`.

## Manual steps performed after booting the instance

1. Admin password changed (see OC secrets `sonarqube-app`).
2. Anonymous access to Nexus removed.
3. Blob stores created e.g docker, leva-documentation, releases, etc.
4. Repositories created e.g docker-group, leva-documentation, pypi-all, etc.
5. Developer account created.

0 comments on commit 414c11a

Please sign in to comment.