Skip to content

Commit

Permalink
docs: add a simple local development guide
Browse files Browse the repository at this point in the history
  • Loading branch information
joekr committed Mar 10, 2022
1 parent d5f1495 commit 8a082c4
Show file tree
Hide file tree
Showing 3 changed files with 56 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -44,3 +44,6 @@ test/e2e/data/infrastructure-oci/v1beta1/cluster-template-bare-metal.yaml
test/e2e/data/infrastructure-oci/v1beta1/cluster-template-custom-networking-seclist.yaml
test/e2e/data/infrastructure-oci/v1beta1/cluster-template-custom-networking-nsg.yaml
test/e2e/data/infrastructure-oci/v1beta1/cluster-template-multiple-node-nsg.yaml

# local development files
auth-config.yaml
41 changes: 41 additions & 0 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Development

The simplest way to test the code is to run it from local.
If you have `capoci-controller-manager` running in your management cluster, please scale down the deployment:
```bash
kubectl scale deployment/capoci-controller-manager --replicas=0 -n cluster-api-provider-oci-system
```
Create and modify the auth-config.yaml file:
```bash
cp <repo-path>/hack/auth-config-template.yaml <repo-path>/auth-config.yaml
```
Then modify the file with your information.

Then run the following commands:
```bash
export AUTH_CONFIG_DIR="<repo-path>/auth-config.yaml"
make run
```
The above step will run the code locally using your local management cluster.

If you want to run your changes using a docker built image execute the following steps:

```bash
export TAG=<tag>
export REGISTRY="<region-key>.ocir.io/<namespace>"
make docker-build
```
`region-key` for example, phx. See the [Availability by Region](https://docs.oracle.com/en-us/iaas/Content/Registry/Concepts/registryprerequisites.htm#Availab) topic in the Oracle Cloud Infrastructure Registry
documentation.

`namespace` is the auto-generated Object Storage namespace string of the tenancy (as shown on the Tenancy Information page)
that owns the repository to which you want to push the image.

Push the resulting docker image to the repository. For more info on how to push to OCIR see https://www.oracle.com/webfolder/technetwork/tutorials/obe/oci/registry/index.html

Execute the following steps to install the image

```bash
make release-manifests
kubectl apply -f out/infrastructure-oci/v0.1.0-alpha1/infrastructure-components.yaml
```
12 changes: 12 additions & 0 deletions hack/auth-config-template.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# see Region Identifier in https://docs.oracle.com/en-us/iaas/Content/General/Concepts/regions.htm
# for a list of regions
region: <region>
tenancy: <tenancy OCID>
user: <user OCID>
key: |
-----BEGIN RSA PRIVATE KEY-----
<key info>
-----END RSA PRIVATE KEY-----
fingerprint: <fingerprint>

useInstancePrincipals: false

0 comments on commit 8a082c4

Please sign in to comment.