MGMT-18227: Add quickstart document for new developers #6744

mlorenzofr · 2024-09-10T14:41:59Z

List all the issues related to this PR

What environments does this code impact?

Automation (CI, tools, etc)
Cloud
Operator Managed Deployments
None

How was this code tested?

assisted-test-infra environment
dev-scripts environment
Reviewer's test appreciated
Waiting for CI to do a full test run
Manual (Elaborate on how it was tested)
No tests needed

Checklist

Title and description added to both, commit and PR.
Relevant issues have been associated (see [CONTRIBUTING] guide)
This change does not require a documentation update (docstring, docs, README, etc)

Reviewers Checklist

Are the title and description (in both PR and commit) meaningful and clear?

openshift-ci-robot · 2024-09-10T14:42:03Z

openshift-ci · 2024-09-10T14:53:14Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mlorenzofr

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:

~~OWNERS~~ [mlorenzofr]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

mlorenzofr · 2024-09-10T16:10:30Z

@rccrdpccl @CrystalChun ptal when possible 🙏

paul-maidment · 2024-09-10T16:31:25Z

docs/dev/README.md

+
+We can start this scenario from the `assisted-test-infra` project:
+```shell
+make run


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 :)

https://spaces.redhat.com/display/AI/Installing+a+cluster+with+assisted-test-infra%2C+kcli+and+aicli+and+HTTP+API

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.

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

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 writtern 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 :)

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.

paul-maidment · 2024-09-10T16:35:19Z

docs/dev/README.md

+## 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.


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

rccrdpccl · 2024-09-11T09:29:18Z

docs/dev/README.md

+## 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.


Not sure I agree, most of the time we'd need BMHs which is problematic to run in local environment.
We are trying to set up a way to work with remote k8s controlplane and VMs to spin up BMHs, but it's WiP.

It should also work on a local environment, but I understand you are concerned about resource usage and how this environment may affect the host. Maybe I can add a warning and recommend deploying it just on remote machines, WDYT?

The second paragraph tried to explain that this environment is still WiP:

If test clusters are to be deployed, additional work will be required, this section is pending development.

It should work on a local environment, but barely with a SNO and not all installations types, as one node requires at least 16GB of memory.
What's needed here is probably similar to Testing kube-api features, but with enough resources to spin up BMHs (which it might also be needed for kube-api).

rccrdpccl · 2024-09-11T09:29:27Z

docs/dev/README.md

+
+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).


What's the difference between this scenario and the one below, Testing infrastructure operator?
Can't it be unified under the same point?

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.

rccrdpccl · 2024-09-11T09:32:12Z

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?

CrystalChun · 2024-09-11T13:25:42Z

docs/dev/README.md

+
+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:


Should there also be a small bit about which repo to clone too?

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?

linoyaslan · 2024-09-16T08:57:00Z

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?

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 dlv, and maybe a comparison of Minikube vs Kind in test-infra. Those are the main things that come to mind right now related to environments.

rccrdpccl · 2024-10-21T13:21:50Z

docs/dev/README.md

+| [podman](##podman) | light | :white_check_mark: | small validations of API REST service |
+| [crc](##crc) | medium | :white_check_mark: | tests with a local SNO Openshift/Microshift cluster |
+| [assisted-test-infra](##assisted-test-infra) | heavy | :x: | testing and development of end-to-end tests |
+| [infrastructure operator](#infrastructure-operator) | light / heavy | :x: | this should be valid to any test related with assisted-installer |


why is infrastrcuture-operator interleaved with podman,crc,test-infra and dev-scripts? Infrastructure Operator is a way to deploy assisted, while the others are frameworks/platforms

The orientation, in all cases, is to do something related to assisted. Maybe it is not clear when putting podman or crc in other sections, in the case of infrastructure operator it would be kind.

Would it be clearer for a new developer if we put kind instead of infrastructure operator?

docs/dev/README.md

rccrdpccl · 2024-10-21T13:24:34Z

docs/dev/README.md

+100c865abfd6  quay.io/edge-infrastructure/assisted-image-service:latest  /assisted-image-s...  3 minutes ago  Up 3 minutes  0.0.0.0:8080->8080/tcp, 0.0.0.0:8090->8090/tcp, 0.0.0.0:8888->8888/tcp  assisted-installer-image-service
+78924b68f7af  quay.io/edge-infrastructure/assisted-service:latest        /assisted-service     3 minutes ago  Up 3 minutes  0.0.0.0:8080->8080/tcp, 0.0.0.0:8090->8090/tcp, 0.0.0.0:8888->8888/tcp  assisted-installer-service
+```
+For testing we can use `curl`:


WDYT about mentioning and linking aicli? Maybe something like:

"For testing we can use curl (or aicli for more complex flows)"

Yes, why not? I usually use aicli for SaaS but it is also possible to use it with a local cluster.
Do I need to provide an example of aicli or is linking it enough?

rccrdpccl · 2024-10-21T13:27:31Z

docs/dev/README.md

+[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**.


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

rccrdpccl · 2024-10-21T13:29:03Z

docs/dev/README.md

+
+There is a section to perform this type of installation in the [Openshift console](https://console.redhat.com/openshift/create/local).
+
+## infrastructure operator


I see this paragraph more as minikube/kind rather than infra operator.
We could deploy assisted with both infra operator or repo's manifests, and we'd achieve the same level of functionality

Same as #r1812796099, maybe I can rename the section to kind instead of infrastructure operator.

rccrdpccl

Great work, overall I think this doc is clear and helpful for a new user. The only thing that I'd change is the section about infra-operator, which IMO is mixing what is deployed with where it's deployed, while all other sections are focused on where and how

openshift-ci · 2024-10-28T13:17:24Z

@mlorenzofr: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
ci/prow/edge-e2e-metal-assisted-odf-4-17	`63a3129`	link	true	`/test edge-e2e-metal-assisted-odf-4-17`
ci/prow/edge-e2e-metal-assisted-mtv-4-17	`f96a58d`	link	true	`/test edge-e2e-metal-assisted-mtv-4-17`

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.

openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Sep 10, 2024

openshift-ci bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Sep 10, 2024

openshift-ci bot requested review from eranco74 and ori-amizur September 10, 2024 14:51

openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 10, 2024

paul-maidment reviewed Sep 10, 2024

View reviewed changes

rccrdpccl reviewed Sep 11, 2024

View reviewed changes

docs/dev/README.md Show resolved Hide resolved

rccrdpccl reviewed Sep 11, 2024

View reviewed changes

CrystalChun reviewed Sep 11, 2024

View reviewed changes

mlorenzofr force-pushed the mgmt-18227 branch from 63a3129 to 82c138e Compare October 15, 2024 08:21

MGMT-18227: Add quickstart document for new developers

f96a58d

mlorenzofr force-pushed the mgmt-18227 branch from 82c138e to f96a58d Compare October 16, 2024 11:05

openshift-ci bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Oct 16, 2024

mlorenzofr requested a review from rccrdpccl October 17, 2024 07:28

rccrdpccl reviewed Oct 21, 2024

View reviewed changes

docs/dev/README.md Show resolved Hide resolved

rccrdpccl reviewed Oct 21, 2024

View reviewed changes

rccrdpccl requested changes Oct 21, 2024

View reviewed changes

openshift-ci bot assigned rccrdpccl Oct 21, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

MGMT-18227: Add quickstart document for new developers #6744

MGMT-18227: Add quickstart document for new developers #6744

mlorenzofr commented Sep 10, 2024

openshift-ci-robot commented Sep 10, 2024 •

edited by openshift-ci bot

Loading

List all the issues related to this PR

What environments does this code impact?

How was this code tested?

Checklist

Reviewers Checklist

openshift-ci bot commented Sep 10, 2024

mlorenzofr commented Sep 10, 2024

paul-maidment Sep 10, 2024 •

edited

Loading

paul-maidment Sep 10, 2024

rccrdpccl Sep 11, 2024

mlorenzofr Sep 11, 2024

paul-maidment Sep 10, 2024 •

edited

Loading

rccrdpccl Sep 11, 2024

mlorenzofr Sep 11, 2024

rccrdpccl Sep 12, 2024

rccrdpccl Sep 11, 2024

mlorenzofr Sep 11, 2024

rccrdpccl commented Sep 11, 2024

CrystalChun Sep 11, 2024

mlorenzofr Sep 11, 2024

linoyaslan commented Sep 16, 2024

rccrdpccl Oct 21, 2024

mlorenzofr Oct 23, 2024

rccrdpccl Oct 21, 2024

mlorenzofr Oct 23, 2024

rccrdpccl Oct 21, 2024

rccrdpccl Oct 21, 2024

mlorenzofr Oct 23, 2024

rccrdpccl left a comment

openshift-ci bot commented Oct 28, 2024


		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).


		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 is a section to perform this type of installation in the [Openshift console](https://console.redhat.com/openshift/create/local).

		## infrastructure operator

MGMT-18227: Add quickstart document for new developers #6744

Are you sure you want to change the base?

MGMT-18227: Add quickstart document for new developers #6744

Conversation

mlorenzofr commented Sep 10, 2024

List all the issues related to this PR

What environments does this code impact?

How was this code tested?

Checklist

Reviewers Checklist

openshift-ci-robot commented Sep 10, 2024 • edited by openshift-ci bot Loading

List all the issues related to this PR

What environments does this code impact?

How was this code tested?

Checklist

Reviewers Checklist

openshift-ci bot commented Sep 10, 2024

mlorenzofr commented Sep 10, 2024

paul-maidment Sep 10, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

paul-maidment Sep 10, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rccrdpccl commented Sep 11, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

linoyaslan commented Sep 16, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rccrdpccl left a comment

Choose a reason for hiding this comment

openshift-ci bot commented Oct 28, 2024

openshift-ci-robot commented Sep 10, 2024 •

edited by openshift-ci bot

Loading

paul-maidment Sep 10, 2024 •

edited

Loading

paul-maidment Sep 10, 2024 •

edited

Loading