Refactor/6 update documentation by pcantera · Pull Request #38 · ingrammicro/concerto

pcantera · 2018-04-26T10:32:25Z

Returning to this activity. Just a starting point, please take a look.

pbanos

👍 I have made some requests though

pbanos · 2018-04-26T11:23:19Z

Getting started with Kubernetes.md

@@ -1,5 +1,5 @@
-
 # Getting started with Kubernetes in IMCO Cloud Orchestrator
+


I would actually remove this whole file: the Kubernetes integration has been removed.

pbanos · 2018-04-26T12:41:17Z

Go Releaser Procedure.md

+
+  Samples:
+
+  ```bash


Use Go instead of bash to obtain nicer syntax highlighting for this snippet

pbanos · 2018-04-26T12:43:45Z

Go Releaser Procedure.md

+
+- Checkout adequate branch.
+
+    The first time for current release, the release branch has to be created.


Actually, the release branch will probably be created long before the first prerrelease has to be published. I would have a reference to the procedure in our SDLC instead of this section.

Maybe the reference should be at the beginning of the document, to state that there is a set of additional procedures that complement those in the SDLC...

pbanos · 2018-04-26T12:49:22Z

README.md

 - [Windows][cli_windows]

-If you want to build the CLI using the source code, please, take into account that the master branch is used for development, it is unstable and might be broken. Download stable tagged versions to use IMCO Cloud Orchestrator CLI.
+If you want to build the CLI using the source code, please, take into account that the master branch is used for development, it is unstable and might be broken. Download stable tagged versions to use IMCO CLI.


Since we are applying the SDLC, this is no longer true: master will always have stable code.

pbanos · 2018-04-26T12:50:11Z

README.md

-You can create a free account in less than a minute following the steps in IMCO Cloud Orchestrator [login page](https://start.concerto.io/).
+### Pre-requisites

+Before setting up the CLI, we will need a IMCO account, and an API key associated with your account.


I think you should use you rather than we here

pbanos · 2018-04-26T12:53:48Z

README.md

+
+- IMCO CLI Binary download
+- Configuration
+- API keys creation


The script shows the Flexiant Concerto logo and has a concerto.io IMCO install as default, it needs further work.

pbanos · 2018-04-26T13:00:35Z

README.md

+
+```bash
 $ cat <<EOF > ~/.concerto/client.xml
 <concerto version="1.0" server="https://clients.concerto.io:886/" log_file="/var/log/concerto-client.log" log_level="info">


The server value depends on the targetted IMCO platform: this should be documented and the example modified to use a value that makes sense (such as the Ingram Micro's Marketplace install)

pbanos · 2018-04-26T13:03:54Z

README.md

-5601726ffef51ac134000028 concertointernal.concerto.io 10800 ns@concerto.io 10800 true
-```
-We have only the default domain. Take note of its ID, `5601726ffef51ac134000028`, and choose a hostname suffix for the new server.
+***TODO*** The server's FQDN will be formed using one of your domains, and a given hostname; Choose a hostname suffix for the new server.


Remove reference about FQDN: with the removal of the managed DNS feature this is no longer needed

pbanos · 2018-04-26T13:04:43Z

README.md

+5641e7497aa4b1a67800006c   joomla-node1   booting        0.0.0.0        55b7326c0cbbc01fc2000008   5641d1ab7aa4b1a678000039   55b0916d10c0ecc35100040e   55b7326b0cbbc01fc2000007
 ```

 ## Kubernetes Cluster


This whole section has to be dropped

pbanos

Some comments, ideas for new issues and change requests, good work!

pbanos · 2018-05-22T15:47:45Z

Go Releaser Procedure.md

@@ -0,0 +1,184 @@
+# Documentation for a publication procedure of the CLI binaries


The title of the document and the name of the file should be more similar, I'd change the name of the file

pbanos · 2018-05-22T15:48:24Z

Go Releaser Procedure.md

+
+The succesive releases will be a set of different releases no published and identified as non-production ready.
+
+Finally, a new release will published and identified as production ready.


It should say a new release will be published

pbanos · 2018-05-22T15:57:58Z

Go Releaser Procedure.md

+  export GITHUB_TOKEN="MY_GITHUB_TOKEN"
+  ```
+
+- Check the '.goreleaser.yml' file and set:


Actually, the edition of the .goreleaser.yml file should be done in step 3 along the setting of the version

pbanos · 2018-05-22T16:00:09Z

Go Releaser Procedure.md

+
+### 6. ONLY IN RTM CASE. Merge into develop branch
+
+In addition, and once the final stable release has been merged into master branch as well as tagged; the master branch must be merged into develop and this should be done through a PR.


We usually do this after publishing the release (which we do here with goreleaser), and though the order does not matter, it makes sense to document it at the end of the procedure so as not to 'break its flow'

pbanos · 2018-05-22T16:09:51Z

README.md

-If you are already using Concerto CLI, and only want to obtain the latest version, download Concerto CLI for:
 - [Linux][cli_linux]
 - [OSX][cli_darwin]
 - [Windows][cli_windows]


The problem with these links is that they redirect to the files in the binaries directory of master, but, since our SDLC prevents us from committing directly to master and the binary for a release cannot be generated until the stable tag on master has been published, master can never have the latest stable version... I would stop distinguishing by OS and redirect users to https://github.com/ingrammicro/concerto/releases/latest

I would also remove the binaries directory from the repo.

pbanos · 2018-05-22T16:33:03Z

README.md

+5aabb7531de0240abb000022   5aabb7511de0240abb000004
+5aabb7531de0240abb000024   5aabb7511de0240abb000005
+5aba0656425b5d0c64000001   5aba04be425b5d0c16000000
+5aba066c425b5d0c64000002   5aba04be425b5d0c16000000


We should start showing the name of the cloud account in this listing...
Also I think it makes sense to rewrite the cloud accounts list command to internally
1.- make an API request to list the cloud accounts,
2.- make an API request to list the cloud providers
3.- map both lists
to show a listing of cloud accounts that shows for each cloud account its cloud provider's id and name

Created issue: #63

created PR #73

pbanos · 2018-05-22T16:35:43Z

README.md

+
 A template must be created with an OS target, a service list, and a list of custom attributes for those services.

 #### Template OS


For some reason this is not mapping into a header...

pbanos · 2018-05-22T16:36:35Z

README.md

-IMCO Cloud Orchestrator takes care of the gap, and lets you select a cloud provider independent OS, and find out later which image is appropriate for the chosen cloud provider and location. Hence blueprints are bound to OS, but cloud provider and location independent.
+IMCO takes care of the gap, and lets you select a cloud provider independent OS, and find out later which image is appropriate for the chosen cloud provider account and location. Hence blueprints are bound to OS, but cloud provider and location independent.

+For our case we will be using Ubuntu 14.04. Let's find its IMCO ID


We should this to Ubuntu 16.04 if it works with the joomla cookbook

pbanos · 2018-05-22T16:40:54Z

README.md

+5aac0c3f348f190b3e001f8d   Basic_A0              768            1              20             5aabb7551de0240abb000060   5aabb7511de0240abb000005
+5aac0c42348f190b3e002038   Basic_A0              768            1              20             5aabb7551de0240abb000062   5aabb7511de0240abb000005
+5aac0c45348f190b3e0020e3   Basic_A0              768            1              20             5aabb7551de0240abb000062   5aabb7511de0240abb000005
+```


Again, we should consider showing the name and id of the cloud provider and location to simplify this workflow, by making a cloud provider listing API request, a location listing API request and then mapping them to the results of the current server plan listing.

Created issue: #64

created PR #74

pbanos · 2018-05-22T16:42:27Z

README.md

+SSH_PROFILE_ID:     5aabb7521de0240abb00000d
+```
+
+You can request for status and see how server is transitioning along service statuses (booting, bootstrapping, operational). Then, after a brief amount of time the final status is reached:


I think it reads out better as You can retrieve the current status of the server and see how it transitions along different statuses (booting, ...

codecov · 2018-05-28T17:12:32Z

Codecov Report

❗ No coverage uploaded for pull request base (develop@04d534c). Click here to learn what that means.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             develop      #38   +/-   ##
==========================================
  Coverage           ?   99.45%           
==========================================
  Files              ?       45           
  Lines              ?     5827           
  Branches           ?        0           
==========================================
  Hits               ?     5795           
  Misses             ?       26           
  Partials           ?        6

Impacted Files	Coverage Δ
api/network/firewall_profiles_api.go	`100% <ø> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 04d534c...45fe472. Read the comment docs.

pbanos

👍

…oud_accounts), rename concerto client name (Ingram Micro), and other small changes. Issue #6

- Added Go Release procedure - Updating readme / kubernetes docs - Update from previous commit changes

- Removing "Getting started with Kubernetes.md" - Updating "Go Releaser Procedure.md" - Updating "README.md" - Updating "install.sh" - Removing obsolete images

See #6

Closes #6

pcantera · 2018-06-11T16:48:51Z

install.sh

 #!/bin/bash

-
 cli_url=https://github.com/ingrammicro/concerto/raw/master/binaries/concerto.x64


From my understanding, this should be changed, because of binaries should not be available anymore.

Something like this should replace it : https://github.com/ingrammicro/concerto/releases/download/{LATEST_RELEASE}/concerto.amd64.linux

I'm right?

Yes, but I'm not sure if it will be easy to get the latest release in the script... maybe we should remove the install.sh...

Closes #6

pbanos

👍

pcantera added refactor WIP labels Apr 26, 2018

pcantera self-assigned this Apr 26, 2018

pcantera requested review from chris-m-h and pbanos April 26, 2018 10:32

pbanos suggested changes Apr 26, 2018

View reviewed changes

pcantera force-pushed the refactor/6-update-documentation branch from 4cd35be to 3e4572c Compare May 15, 2018 15:02

pbanos suggested changes May 22, 2018

View reviewed changes

pcantera force-pushed the refactor/6-update-documentation branch 4 times, most recently from 7779b70 to 9a7e2de Compare May 28, 2018 17:10

pbanos approved these changes May 29, 2018

View reviewed changes

pcantera force-pushed the refactor/6-update-documentation branch 3 times, most recently from 0dbbcb3 to fd75c27 Compare May 30, 2018 11:22

Fco Javier Coira and others added 8 commits June 11, 2018 17:08

Update concerto cli name and logo. Issue #5

548c561

Update README.md: add new parameter about templates and instances (cl…

f5fbbb6

…oud_accounts), rename concerto client name (Ingram Micro), and other small changes. Issue #6

Continue updating process (issue #6)

930695a

- Added Go Release procedure - Updating readme / kubernetes docs - Update from previous commit changes

Updating process (issue #6)

407f69d

- Removing "Getting started with Kubernetes.md" - Updating "Go Releaser Procedure.md" - Updating "README.md" - Updating "install.sh" - Removing obsolete images

Applied requested changes (issue #6)

6b44a29

See #6

Fix travis step (issue #6)

0e12602

Fix wrong fprintf format (issue #6)

7012271

Updated based on last changes(issue #6)

63ae8de

Closes #6

pcantera force-pushed the refactor/6-update-documentation branch from d408041 to 63ae8de Compare June 11, 2018 15:09

Updated based on new response for commands (issue #6)

e582163

Closes #6

pcantera commented Jun 11, 2018

View reviewed changes

Remove automated installation script (issue #6)

45fe472

Closes #6

pbanos approved these changes Jun 20, 2018

View reviewed changes

pcantera merged commit 09aad2f into develop Jun 20, 2018

		@@ -1,5 +1,5 @@

		# Getting started with Kubernetes in IMCO Cloud Orchestrator


		- Checkout adequate branch.

		The first time for current release, the release branch has to be created.

		@@ -0,0 +1,184 @@
		# Documentation for a publication procedure of the CLI binaries


		The succesive releases will be a set of different releases no published and identified as non-production ready.

		Finally, a new release will published and identified as production ready.


		### 6. ONLY IN RTM CASE. Merge into develop branch

		In addition, and once the final stable release has been merged into master branch as well as tagged; the master branch must be merged into develop and this should be done through a PR.


		A template must be created with an OS target, a service list, and a list of custom attributes for those services.

		#### Template OS

		#!/bin/bash


		cli_url=https://github.com/ingrammicro/concerto/raw/master/binaries/concerto.x64

Conversation

pcantera commented Apr 26, 2018

Uh oh!

pbanos 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!

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!

pbanos 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!

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!

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!

codecov bot commented May 28, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

pbanos 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!

pbanos left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

codecov bot commented May 28, 2018 •

edited

Loading