MGMT-18227: Add quickstart document for new developers #6744
Conversation
openshift-ci-robot
added
the
jira/valid-reference
|
@mlorenzofr: This pull request references MGMT-18227 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the sub-task to target the "4.18.0" version, but no target version was set. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
openshift-ci
bot
added
the
size/M
openshift-ci
bot
added
the
approved
|
@rccrdpccl @CrystalChun ptal when possible 🙏 |
docs/dev/README.md
Outdated
|
|
||
| We can start this scenario from the `assisted-test-infra` project: | ||
| ```shell | ||
| make run |
There was a problem hiding this comment.
I have been working on a guide for this use case, it's a workflow that I use regularly.
Feel free to use as much or as little as you like to add to this.
I am a big fan of using aicli and kcli, two great utilities written by our own @karmab so I have included setup information for my favoured use case in this doc.
Note that aicli and kcli are not official RedHat tools ... But they are superb :)
There was a problem hiding this comment.
We really should mention that assisted-test-infra requires setup before you can perform make run
Also we should make it clear that assisted-test-infra is very opinionated during the setup phase and that the ideal place to use it is on a Beaker box or other ephemeral server. Using this on your laptop could cause some pain.
There was a problem hiding this comment.
I am a big fan of using aicli and kcli, two great utilities writtern by our own @karmab so I have included setup information for my favoured use case in this doc.
I agree with Paul, should we mention those tools in the docs? We mention "tests" a lot, and I belive they are implied to be manual most of the time, aicli is a nice tool to do that, and kcli also is worth a mention IMO
There was a problem hiding this comment.
I have been working on a guide for this use case, it's a workflow that I use regularly.
Feel free to use as much or as little as you like to add to this.
I am a big fan of using
aicliandkcli, two great utilities writtern by our own @karmab so I have included setup information for my favoured use case in this doc.Note that
aicliandkcliare not official RedHat tools ... But they are superb :)
I would create a simplified setup guide and add it to project assisted-test-infra, leaving a reference here. This way anyone who comes directly to the assisted-test-infra repository will also be able to find it.
BTW, 100% agree on reusing Paul's doc, but I need to review it, I'm having trouble logging into confluence right now.
docs/dev/README.md
Outdated
| ## Testing Cluster-API (sylva/CAPI) | ||
| [Development environment using kind](kind/README.md) | ||
|
|
||
| If you are involved in the Cluster API (CAPI) project, which is responsible for the k8s cluster lifecycle management subsystem, you have a small development environment deployed in a local kind environment that will allow you to test it. |
There was a problem hiding this comment.
Could we get a link to some documentation for CAPI here, something to give the reader the background they need to understand what CAPI and how it is being used?
I might not be working on a CAPI project today but I certainly want to learn all about CAPI.
docs/dev/README.md
Outdated
|
|
||
| The goal here would be to test the operation of the resources associated with assisted-installer through the kube-api. This is a lightweight scenario and we could work with a local environment. | ||
|
|
||
| We can install a local environment (Openshift / OKD / Microshift) with the **crc** tool. There is a section to perform this type of installation in the [Openshift console](https://console.redhat.com/openshift/create/local). |
There was a problem hiding this comment.
What's the difference between this scenario and the one below, Testing infrastructure operator?
Can't it be unified under the same point?
There was a problem hiding this comment.
I actually added this as another possibility since we had it as a reference in the ticket, but we could actually do these same tests with the infrastructure-operator scenario. If it is redundant and clearer we could eliminate this scenario.
|
I think it would be clearer to state the possible type of environments by section, and each section explaining some use cases for such environment (with links to projects and all for more details. WDYT? Also, I think the opinion of new team members would help a lot. cc @linoyaslan @omer-vishlitzky WDYT? |
docs/dev/README.md
Outdated
|
|
||
| In this scenario the goal is to run small tests with the assisted-installer REST API. This can be done in a local environment by starting the assisted-service with podman. | ||
|
|
||
| We can start it directly with make: |
There was a problem hiding this comment.
Should there also be a small bit about which repo to clone too?
There was a problem hiding this comment.
I would add it at the beginning, before starting with the possible scenarios because in all the shellcode boxes with make you are supposed to run make after cloning this repository. Maybe a small section called pre-requisites WDYT?
I think it's a great idea! It would be helpful to expand the documentation with a deeper dive into test-infra details, like how to debug using |
mlorenzofr
force-pushed
the
mgmt-18227
branch
2 times, most recently
from
82c138e to
f96a58d
Compare
openshift-ci
bot
added
size/L
| [Detailed documentation](https://github.com/openshift/assisted-test-infra/blob/master/README.md) | ||
|
|
||
| This scenario is useful for developing and testing our end-to-end tests. | ||
| This environment requires a large amount of resources since it will deploy additional baremetal hosts (VMs), so **running it in local environments is not recommended, do it on a beaker box or an ephemeral server**. |
There was a problem hiding this comment.
The main reason it's not recommended to run in local envs is not about resource usage, but it will change some host configuration that might be relevant for the user. Maybe worth mentioning? Maybe something like Assisted Test infra is an opinionated framework and running it in local environments is not recommended as it will change settings to the host
|
@mlorenzofr: The following tests failed, say
Full PR test history. Your PR dashboard. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
mlorenzofr
force-pushed
the
mgmt-18227
branch
2 times, most recently
from
65f54f4 to
ebf67e6
Compare
mlorenzofr
force-pushed
the
mgmt-18227
branch
from
ebf67e6 to
4798994
Compare
|
/lgtm |
|
/retest |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: mlorenzofr, rccrdpccl The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
List all the issues related to this PR
What environments does this code impact?
How was this code tested?
Checklist
docs, README, etc)Reviewers Checklist