-
Notifications
You must be signed in to change notification settings - Fork 26
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
docs: add a simple local development guide #28
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please add more explicit steps.
76c54c5
to
8a082c4
Compare
Can you please lint all your Markdown files using |
I suggest following the same layout as the AWS development guide: https://cluster-api-aws.sigs.k8s.io/development/development.html, i.e. start with explaining the prequisites, then set up the environment, then how to commit, etc. |
8a082c4
to
eed3e59
Compare
@Djelibeybi ended up moving the doc into the book like you pointed out and expanding upon the developer guide a bit. |
eed3e59
to
ff36a79
Compare
ff36a79
to
73bcbb1
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
feedback provided
73bcbb1
to
d8198f2
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is really good, but it's missing the process to lint, test and then submit changes back upstream, which is possibly because we haven't defined that yet. If we have (or if the SIG has preferred options for each), it would be great if those could be documented.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Whoops, clicked the wrong button.
d8198f2
to
a2eaea1
Compare
a2eaea1
to
05dabe7
Compare
1. Install make. | ||
- `$ xcode-select --install` on macOS. | ||
- `$ sudo apt-get install build-essential` on Ubuntu Linux | ||
- `$ sudo dnf install make gcc` on Oracle Linux | ||
1. Install [Go][go] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Try this:
1. Install make. | |
- `$ xcode-select --install` on macOS. | |
- `$ sudo apt-get install build-essential` on Ubuntu Linux | |
- `$ sudo dnf install make gcc` on Oracle Linux | |
1. Install [Go][go] | |
1. Install the required build tools for each operating system: | |
- macOS: `xcode-select --install` | |
- Oracle Linux: `sudo yum install make gcc` | |
- Ubuntu Linux: `sudo apt-get install build-essential` | |
1. Install [Go][go] by following the [installation guide](https://go.dev/doc/install). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The OSs are sorted alphabetically too.
1. Install [KIND][kind] | ||
- `$ GO111MODULE="on" go get sigs.k8s.io/[email protected]`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
1. Install [KIND][kind] | |
- `$ GO111MODULE="on" go get sigs.k8s.io/[email protected]`. | |
1. Install [KIND][kind] by running the following command on all platforms: `$ GO111MODULE="on" go get sigs.k8s.io/[email protected]`. |
1. Install [Kustomize][kustomize] | ||
- [install instructions][kustomizelinux] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
1. Install [Kustomize][kustomize] | |
- [install instructions][kustomizelinux] | |
1. Install [Kustomize][kustomize] by following the [install instructions][kustomizelinux]. |
1. Install [envsubst][envsubst] | ||
- `$ go get github.com/a8m/envsubst/cmd/envsubst` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
1. Install [envsubst][envsubst] | |
- `$ go get github.com/a8m/envsubst/cmd/envsubst` | |
1. Install [envsubst][envsubst] by running the following command on all platforms: `go get github.com/a8m/envsubst/cmd/envsubst` |
1. Install [envsubst][envsubst] | ||
- `$ go get github.com/a8m/envsubst/cmd/envsubst` | ||
|
||
## Fork and get the source |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
## Fork and get the source | |
## Fork and clone this repository |
If you have `capoci-controller-manager` running in your management cluster, | ||
please scale down the deployment, otherwise running your development build will conflict with the | ||
currently running `capoci-controller-manager`: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you have `capoci-controller-manager` running in your management cluster, | |
please scale down the deployment, otherwise running your development build will conflict with the | |
currently running `capoci-controller-manager`: | |
> **Note:** If you are re-using an existing management cluster that already has `capoci-controller-manager` installed, be sure to provide sufficient resources for both instances or scale down the existing instances to release resources for the new instance. |
To build, run and test all your code changes locally, copy the | ||
`hack/auth-config-template.yaml` file to `<path-to-your-repo>/auth-config.yml` in your | ||
cloned copy of the repository and modify it to match your local configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To build, run and test all your code changes locally, copy the | |
`hack/auth-config-template.yaml` file to `<path-to-your-repo>/auth-config.yml` in your | |
cloned copy of the repository and modify it to match your local configuration. | |
To build, run and test all your code changes locally, copy the `hack/auth-config-template.yaml` to `hack/auth-config.yml` and modify it to match your local configuration. |
`hack/auth-config-template.yaml` file to `<path-to-your-repo>/auth-config.yml` in your | ||
cloned copy of the repository and modify it to match your local configuration. | ||
|
||
Then run the following commands: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Then run the following commands: | |
After populating the local configuration file to suit your envornment, the following command will run the test suite: |
Then run the following commands: | ||
|
||
```bash | ||
export AUTH_CONFIG_DIR="<path-to-your-repo>/auth-config.yaml" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
export AUTH_CONFIG_DIR="<path-to-your-repo>/auth-config.yaml" | |
export AUTH_CONFIG_DIR="hack/auth-config.yaml" |
following steps: | ||
|
||
```bash | ||
export TAG=<tag> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
export TAG=<tag> | |
export TAG="$(git rev-parse --short HEAD)" |
What this PR does / why we need it:
Simply adds a markdown doc for local development. I keep forgetting what the auth config and registry ENVs when doing development work
Which issue(s) this PR fixes:
No open issues for this PR