Added README.md. #11

Merged
merged 3 commits into from Jun 1, 2016

Conversation

Projects
None yet
4 participants

petevg commented May 25, 2016

(No longer a WIP -- would like final feedback before merging.)

Outlines basic usage of the layer, with some example code. I patterned
the README after the one in layer-hadoop-client, as it was mentioned
positively in freenode#juju.

@juju-solutions/bigdata

Added README.md.
Outlines basic usage of the layer, with some example code. I patterned
the README after the one in layer-hadoop-client, as it was mentioned
positively in freenode#juju.
README.md
+hosts = {'myservice': <host>}
+roles = ['myservice-worker', 'myservice-client']
+override = {'myservice::somevalue': <somevalue>, ...}
+
@ktsakalozos

ktsakalozos May 25, 2016

Member

I think we need to be more precise here. For examples, the roles are actually the bigtop roles that they do not follow the pattern "'myservice-worker', 'myservice-client'". Instead we should be giving some link to a list of bigtop roles like this one inferred from https://github.com/apache/bigtop/blob/master/bigtop-deploy/puppet/manifests/cluster.pp#L16 . Unfortunately I haven't found an exhaustive list of all bigtop roles. Similarly, the hosts is there to indicate some fqdn the service we deploy might need, again a list of host types that we support would add more value.

@petevg

petevg May 25, 2016

I wanted to give a generic example, without being too specific. Does it work to replace "worker" and "client" with something even more generic? For example:

roles = ['myservice-servertype0', 'myservice-servertype1']
@petevg

petevg May 25, 2016

... or maybe:

roles = ['some_bigtop_service_worker', 'some_bigtop_service_client', ...]
README.md
+inspecting the "hosts" that you pass to .render_site_yaml, or it can
+install the specific services that you name in "roles".
+
+Of course, Bigtop needs to know how to deploy your service!
@ktsakalozos

ktsakalozos May 25, 2016

Member

There are two service deployment methods for bigtop. You can either specify the roles to have a more fine grained control on what is deployed, or you can specify a component for with ultimately an predefined set of roles is configured. Our component deployment path is not well tested, so it might not be functional at the moment.

@petevg

petevg May 25, 2016

Thanks. I'll mention that the component method may not work.

README.md
+
+This layer will set the following states:
+
+ * **`apache-bigtop-base.puppet_queued`** This indicates that puppet
@ktsakalozos

ktsakalozos May 25, 2016

Member

I do not know if this state has any practical use for the other layers

@petevg

petevg May 25, 2016

It's a mayfly of a state. I will go ahead and chop it out.

@johnsca

johnsca May 25, 2016

Owner

It does have use for charm layers, to allow them to know that the requested puppet apply has been processed (because the state is gone). We're using it in the DataNode layer (and similarly in the NameNode layer) for that purpose. I think it's worth keeping in the documentation.

README.md
+
+# Actions
+
+As of this writing, this layer does not define any actions.
@ktsakalozos

ktsakalozos May 25, 2016

Member

There is some unofficial standard way to close the README. We always provide the the contact details of the team. IRC and lists.

@petevg

petevg May 25, 2016

I will add that. Thank you.

@petevg petevg changed the title from [WIP] Added README.md. to Added README.md. May 27, 2016

@kwmonroe kwmonroe merged commit 97c9008 into master Jun 1, 2016

ktsakalozos added a commit that referenced this pull request Jun 1, 2016

Added README.md. (#11)
* Added README.md.

Outlines basic usage of the layer, with some example code. I patterned
the README after the one in layer-hadoop-client, as it was mentioned
positively in freenode#juju.

* Updated README based on feedback in the WIP PR.

* Cleaned up the writing a bit in the README.

Untwisted some sentences, and tightened up the flow.

@kwmonroe kwmonroe deleted the add-readme branch Jun 1, 2016

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment