Skip to content

Commit

Permalink
Merge pull request #432 from equinor/sample-repos
Browse files Browse the repository at this point in the history
Removed refs to (now) deleted repos
  • Loading branch information
emirgens authored Dec 20, 2024
2 parents a521cc9 + 180e543 commit 6da8d3f
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 7 deletions.
6 changes: 1 addition & 5 deletions public-site/docs/guides/git-submodules/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,10 @@ As of December 2022, Radix only supports a single SSH key for authenticating to
There is an option to update submodule within the pipeline job. Please look [at the example](/guides/git-submodules/update-submodule-in-pipeline-job.md).
:::

## Sample application with git submodule

[This GitHub repository](https://github.com/equinor/radix-app-with-submodule-example) contains a Radix application that has a single component, `redis`. This component is built from the source code inside the `redis` directory, and this directory is in turn a git submodule which points to a git repository at https://github.com/equinor/radix-submodule-example. Take note that the remote URL of the submodule is HTTPS and not SSH; unauthenticated clone via SSH, even for public repositories, is not supported.

### Trigger build of main app with commit to submodule

By default, a submodule reference is statically locked to a single commit in the remote repository. E.g. a dynamic reference to a branch of the submodule is not possible. If a new commit is made in the sub-module, this will not be reflected in the main repository unless the main repository is updated with a new commit reference.

A development team might want a change in the submodule to be automatically reflected in parent repositories. This can be achieved with a GitHub actions workflow on the submodule repository which automatically updates the parent repositories. The submodule in the example has [such a workflow](https://github.com/equinor/radix-submodule-example/blob/main/.github/workflows/push-to-main-repo.yml).
A development team might want a change in the submodule to be automatically reflected in parent repositories. This can be achieved with a GitHub actions workflow on the submodule repository which automatically updates the parent repositories.

The example workflow uses a deploy key with write access to automatically modify the parent repository when the submodule is modified. If a new commit is made to the `main` branch of the submodule, the `main` branch of the parent repository gets a new commit which changes the submodule reference to point to HEAD of the submodule's `main` branch.
4 changes: 2 additions & 2 deletions public-site/docs/guides/volume-mounts/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ volumes:
and files appear inside the container. If there are folders within blob container - it will exist in the pod's container as well
```sh
kubectl exec -it -n radix-csi-azure-example-dev deploy/frontend -- ls -l /app/image-storage
kubectl exec -it -n radix-example-dev deploy/frontend -- ls -l /app/image-storage
total 0
-rwxrwxrwx 1 root root 21133 Nov 13 13:56 image-01.png
-rwxrwxrwx 1 root root 21989 Nov 13 13:56 image-02.png
Expand Down Expand Up @@ -136,7 +136,7 @@ volumes:
and files appear inside the container
```sh
kubectl exec -it -n radix-csi-azure-example-dev deploy/frontend -- ls -lR /app
kubectl exec -it -n radix-example-dev deploy/frontend -- ls -lR /app
/app:
total 4
drwxrwxrwx 2 root root 4096 Dec 11 15:10 image-storage
Expand Down

0 comments on commit 6da8d3f

Please sign in to comment.