CNV-1589: Provision and manage VMs using Ansible modules #14914

pkliczewski · 2019-05-17T13:38:52Z

No description provided.

pkliczewski · 2019-05-17T13:41:11Z

@ousleyp please review

cnv/cnv_users_guide/cnv-ansible-modules.adoc

alexxa · 2019-05-22T09:32:24Z

@pkliczewski @ousleyp Can we merge it ASAP, please? The ansible 2.8 release was on 16th.

pkliczewski · 2019-05-22T09:37:09Z

@alexxa I fixed the typo and I think it is ready. @ousleyp please review

ousleyp · 2019-05-22T14:07:33Z

@pkliczewski @ousleyp Can we merge it ASAP, please? The ansible 2.8 release was on 16th.

Wait, is this supposed to be for CNV 1.4 docs or CNV 2.0 (the PR is against enterprise-4.1 which suggests CNV 2.0)? If it's for CNV 2.0, it won't go out for awhile regardless.

I'm sorry for the delay - I'm waiting on some info about the official way to refer to Ansible in the docs. Most of our docs just say "Ansible" like you did, but the official spreadsheet says otherwise. There are a couple other minor things that I'll note inline.

I'll get back to you ASAP, but please let me know which version in the meantime. Thanks!

pkliczewski · 2019-05-22T14:19:32Z

@ousleyp Yes, it is CNV 2.0 item as you can see in CNV-1589 we want to have something similar to RHV doc.

ousleyp

Overall, looks good. Thanks for trying to follow our (confusing, ever-changing) modular docs standards. :) There are some things to fix, and I need to follow up on the naming issue, but then we should be good to merge.

ousleyp · 2019-05-22T14:19:06Z

cnv/cnv_users_guide/cnv-ansible-modules.adoc

+:context: cnv-ansible-modules
+toc::[]
+
+Ansible is an automation tool used to configure systems, deploy software, and perform rolling updates.


I'm waiting to find out if "Ansible" is okay or if the shortname should be "Ansible Automation" which is how it's written in the spreadsheet of official product names/shortnames. I'm not sure if the list is out-of-date or if it's a new convention that we should start following.

In RHV documentation we use Ansible.

Thanks for letting me know. I know that in the rest of the OpenShift docs, "Ansible" is used, but it's possible the "Ansible Automation" guideline is new. I'll let you know when I have confirmation.

cnv/cnv_users_guide/cnv-ansible-modules.adoc

alexxa · 2019-05-22T15:22:44Z

Wait. @pkliczewski, When I asked Vatsal whether ansible modules are 1.4 or 2.0 'feature', I was told 'they work for both, and were tested for both versions.'

pkliczewski · 2019-05-22T15:25:01Z

@alexxa We want to document it as part of 2.0. Ansible 2.8 was released on 16th of May and it was not available before.

ousleyp · 2019-05-28T20:40:35Z

@pkliczewski LGTM (still unsure about "Ansible Automation" vs. "Ansible" as the short name, but I can fix it later if necessary)

One last thing that I'm aware of - can you please squash your commits into one commit?

@kalexand-rh @vikram-redhat is there anything else barring us from merging this? One of us will make an assembly for it as part of CNV-1589.

vikram-redhat · 2019-05-29T03:05:03Z

@ousleyp - I am assuming here that QE and peer review are done. Other than that, once we squash the commits we should be ok to merge.

pkliczewski · 2019-05-29T07:28:04Z

@ousleyp @vikram-redhat commits squashed. Please take a look

bergerhoffer · 2019-05-29T14:08:58Z

cnv/cnv_users_guide/cnv-ansible-modules.adoc

@@ -0,0 +1,15 @@
+// Module included in the following assemblies:


If this file is a module, then it should go in the modules/ directory.

Ah, excellent catch! Piotr, please move the file to the modules directory. Thanks :)

bergerhoffer · 2019-05-29T14:09:37Z

cnv/cnv_users_guide/cnv-ansible-modules.adoc

@@ -0,0 +1,15 @@
+// Module included in the following assemblies:
+//
+// *


And I can see that this module isn't added to an assembly yet (should it be now?), but when you're ready, then it should be updated here to list which assembly the module is a part of.

@bergerhoffer One of us from CNV docs is going to do a follow-up PR to create an assembly for this module.

bergerhoffer · 2019-05-29T14:11:20Z

cnv/cnv_users_guide/cnv-ansible-modules.adoc

+cluster management tasks such as template, persistent volume claim, and virtual machine operations.
+
+Ansible provides a way to automate {ProductName} management, which you can also accomplish by using
+the oc CLI tool or APIs. Ansible is unique because it allows you to integrate


oc should be in backticks here, `oc`

bergerhoffer · 2019-05-29T14:14:02Z

cnv/cnv_users_guide/cnv-ansible-modules.adoc

+
+[id="cnv-ansible-modules_{context}"]
+= Automating {ProductName} management tasks by using Red Hat Ansible Automation
+include::modules/cnv-document-attributes.adoc[]


I'm not sure if how CNV does things is different, but I think once you add this module to an assembly, I'd think the assembly should include this attribtues file, and you wouldn't include it here.

bergerhoffer · 2019-05-29T14:17:38Z

cnv/cnv_users_guide/cnv-ansible-modules.adoc

+// *
+
+[id="cnv-ansible-modules_{context}"]
+= Automating {ProductName} management tasks by using Red Hat Ansible Automation


@ousleyp just a general comment (not for this PR) - this attribute name is a little confusing, since we have "product-title" for OpenShift and if I hadn't build it, I wouldn't have known that this was the CNV product name. I'd suggest to change this attribute name to CNVProductName or something, so that it's easier to understand from the source that it's CNV's name.

@bergerhoffer Good call, I have wondered if this is confusing. I can bring it up in our CNV meeting this week.

ousleyp · 2019-05-29T14:57:10Z

Piotr, there are just a couple of changes left:

remove the line "include::modules/cnv-document-attributes.adoc[]"
line 14: "the oc CLI tool" -> "the `oc` CLI tool"
move the file into the modules folder
squash commits into one commit again

Then we should be able to merge. Thanks!

pkliczewski · 2019-05-29T15:25:26Z

@ousleyp Sure, thank you for the list. I am on it

Co-Authored-By: Pan Ousley <[email protected]>

pkliczewski · 2019-05-30T07:59:58Z

@ousleyp @bergerhoffer @vikram-redhat please review again all comments fixed

ousleyp · 2019-05-30T15:13:08Z

@ousleyp @bergerhoffer @vikram-redhat please review again all comments fixed

LGTM. Please merge this PR if you agree, @vikram-redhat and/or @kalexand-rh :) Thanks.

pkliczewski · 2019-06-04T16:46:29Z

@vikram-redhat @kalexand-rh please review and let me know if you want me to fix something

kalexand-rh · 2019-06-04T17:50:27Z

I think this looks fine. Merging.

vikram-redhat · 2019-09-02T04:48:46Z

@ousleyp @kalexand-rh this module is never referenced from anywhere. As part of my #16426 PR to update the CNV attributes, this is marked as deleted in the 4.2 branch. Does this seem correct?

I have added it back via the CP to 4.2 (#16464), but please feel free to delete if it doesn't make sense.

ousleyp · 2019-09-03T14:29:09Z

@vikram-redhat yes, that does seem correct - I renamed the file to modules/cnv-about-red-hat-ansible-automation.adoc in #15956

I'll go ahead and delete modules/cnv-ansible-modules.adoc in that branch again - no worries.

openshift-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label May 17, 2019

alexxa suggested changes May 22, 2019

View reviewed changes

cnv/cnv_users_guide/cnv-ansible-modules.adoc Outdated Show resolved Hide resolved

pkliczewski force-pushed the enterprise-4.1 branch from e6cb2ef to b40a51a Compare May 22, 2019 09:36

ousleyp requested changes May 22, 2019

View reviewed changes

pkliczewski force-pushed the enterprise-4.1 branch from 6635b24 to 86739a6 Compare May 23, 2019 07:52

pkliczewski force-pushed the enterprise-4.1 branch from 86739a6 to 7600f8f Compare May 29, 2019 07:24

bergerhoffer added branch/enterprise-4.1 peer-review-needed Signifies that the peer review team needs to review this PR labels May 29, 2019

bergerhoffer added this to the Future Release milestone May 29, 2019

bergerhoffer reviewed May 29, 2019

View reviewed changes

bergerhoffer added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR labels May 29, 2019

CNV-1589: Provision and manage VMs using Ansible modules

43fc26d

Co-Authored-By: Pan Ousley <[email protected]>

pkliczewski force-pushed the enterprise-4.1 branch from 7600f8f to 43fc26d Compare May 30, 2019 07:58

kalexand-rh merged commit 7047435 into openshift:enterprise-4.1 Jun 4, 2019

kalexand-rh mentioned this pull request Jun 4, 2019

CNV-1589: Provision and manage VMs using Ansible modules #15176

Merged

		@@ -0,0 +1,15 @@
		// Module included in the following assemblies:

CNV-1589: Provision and manage VMs using Ansible modules #14914

CNV-1589: Provision and manage VMs using Ansible modules #14914

Uh oh!

Conversation

pkliczewski commented May 17, 2019

Uh oh!

pkliczewski commented May 17, 2019

Uh oh!

Uh oh!

alexxa commented May 22, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pkliczewski commented May 22, 2019

Uh oh!

ousleyp commented May 22, 2019

Uh oh!

pkliczewski commented May 22, 2019

Uh oh!

ousleyp left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

alexxa commented May 22, 2019

Uh oh!

pkliczewski commented May 22, 2019

Uh oh!

ousleyp commented May 28, 2019

Uh oh!

vikram-redhat commented May 29, 2019

Uh oh!

pkliczewski commented May 29, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ousleyp commented May 29, 2019

Uh oh!

pkliczewski commented May 29, 2019

Uh oh!

pkliczewski commented May 30, 2019

Uh oh!

ousleyp commented May 30, 2019

Uh oh!

pkliczewski commented Jun 4, 2019

Uh oh!

kalexand-rh commented Jun 4, 2019

Uh oh!

vikram-redhat commented Sep 2, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ousleyp commented Sep 3, 2019

Uh oh!

Uh oh!

alexxa commented May 22, 2019 •

edited

Loading

vikram-redhat commented Sep 2, 2019 •

edited

Loading