Re: Proposal: require DESCRIPTION, USAGE label for images

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Tue, Dec 13, 2016 at 3:24 PM, Josh Berkus <jberkus@xxxxxxxxxx> wrote:
> Folks,
>
> Looking at the new FDLIBS, I'm noticing that there's not a narrative
> description of the image required or provided anywhere that I can find.
> Clearly one is needed for users.  So, here's a proposal:
>
> New Required LABELs:
>
>         USAGE: single command line giving usage example
>              for invoking the container; will be "N/A" for
>              some containers.
>
>         DESCRIPTION: Narrative description incuding:
>           * What service/software it provides
>           * What specific purpose it fulfills, if required
>           * Notes on how to use it, if not covered by USAGE,
>             such as how to supply configuration files
>           * Depedencies on other images (e.g. "requires a database")
>           * Links to documentation for the Software, if any
>

+1 - I like this, it follows nicely with the upstream guidelines[0]
referenced in Fedora's that I'd like to further adopt as all of this
evolves in Fedora space.

I'd also at some point like to discuss the labels needed for atomic
app install/uninstall and OpenShift guidelines[1] that we should at
least provide information on how to offer the 'atomic install' and
OpenShift deployment functionality for a container to users.

-AdamM

[0] - https://github.com/projectatomic/ContainerApplicationGenericLabels
[1] - https://docs.openshift.org/latest/creating_images/guidelines.html#openshift-specific-guidelines

> --
> --
> Josh Berkus
> Project Atomic
> Red Hat OSAS
> _______________________________________________
> cloud mailing list -- cloud@xxxxxxxxxxxxxxxxxxxxxxx
> To unsubscribe send an email to cloud-leave@xxxxxxxxxxxxxxxxxxxxxxx
_______________________________________________
cloud mailing list -- cloud@xxxxxxxxxxxxxxxxxxxxxxx
To unsubscribe send an email to cloud-leave@xxxxxxxxxxxxxxxxxxxxxxx




[Index of Archives]     [Fedora General Discussion]     [Older Fedora Users Archive]     [Fedora Advisory Board]     [Fedora Security]     [Fedora Devel Java]     [Fedora Legacy]     [Fedora Desktop]     [ATA RAID]     [Fedora Marketing]     [Fedora Mentors]     [Fedora Package Announce]     [Fedora Package Review]     [Fedora Music]     [Fedora Packaging]     [Centos]     [Fedora SELinux]     [Coolkey]     [Yum Users]     [Big List of Linux Books]     [Yosemite News]     [Linux Apps]     [KDE Users]     [Fedora Art]     [Fedora Docs]     [Asterisk PBX]

  Powered by Linux