Updates to user guide (#242)

* Updates to user guide * Update user-guide.md
appsody · Mar 18, 2020 · b69be99 · b69be99
1 parent bfce7b1
commit b69be99
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/doc/user-guide.md b/doc/user-guide.md
@@ -54,6 +54,8 @@ Each `AppsodyApplication` CR must at least specify the `applicationImage` parame
 | `version`                                    | The current version of the application. Label `app.kubernetes.io/version` will be added to all resources when the version is defined.                                                                                                                                                                                                                                                                      |
 | `serviceAccountName`                         | The name of the OpenShift service account to be used during deployment.                                                                                                                                                                                                                                                                                                                                    |
 | `applicationImage`                           | The Docker image name to be deployed. On OpenShift, it can also be set to `<project name>/<image stream name>[:<tag>]` to reference an image from an image stream. If `<project name>` and `<tag>` values are not defined, they default to the namespace of the CR and the value of `latest`, respectively.                                                                                                |
+| `applicationName`                            | The name of the application this resource is part of. If not specified, it defaults to the name of the CR.                                                                                                                                                                                                                                                                                                 |
+| `createAppDefinition`                        | A boolean to toggle the automatic configuration of Kubernetes resources for the `AppsodyApplication` CR to allow creation of an application definition by [kAppNav](https://kappnav.io/). The default value is `true`. See [Application Navigator](https://github.com/application-stacks/runtime-component-operator/blob/master/doc/user-guide.md#kubernetes-application-navigator-kappnav-support) for more information.                                                                                |
 | `pullPolicy`                                 | The policy used when pulling the image.  One of: `Always`, `Never`, and `IfNotPresent`.                                                                                                                                                                                                                                                                                                                    |
 | `pullSecret`                                 | If using a registry that requires authentication, the name of the secret containing credentials.                                                                                                                                                                                                                                                                                                           |
 | `initContainers`                             | The list of [Init Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.14/#container-v1-core) definitions.                                                                                                                                                                                                                                                                          |
@@ -97,7 +99,6 @@ Each `AppsodyApplication` CR must at least specify the `applicationImage` parame
 | `storage.volumeClaimTemplate`                | A YAML object representing a [volumeClaimTemplate](https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#components) component of a `StatefulSet`.                                                                                                                                                                                                                                        |
 | `monitoring.labels`                          | Labels to set on [ServiceMonitor](https://github.com/coreos/prometheus-operator/blob/master/Documentation/api.md#servicemonitor).                                                                                                                                                                                                                                                                          |
 | `monitoring.endpoints`                       | A YAML snippet representing an array of [Endpoint](https://github.com/coreos/prometheus-operator/blob/master/Documentation/api.md#endpoint) component from ServiceMonitor.                                                                                                                                                                                                                                 |
-| `createAppDefinition`                        | A boolean to toggle the automatic configuration of `AppsodyApplication`'s Kubernetes resources to allow creation of an application definition by [kAppNav](https://kappnav.io/). The default value is `true`. See [Application Navigator](#kubernetes-application-navigator-kappnav-support) for more information.                                                                                         |
 | `route.annotations`                          | Annotations to be added to the service.                                                                                                                                                                                                                                                                                                                                                                    |
 | `route.host`                                 | Hostname to be used for the Route.                                                                                                                                                                                                                                                                                                                                                                         |
 | `route.path`                                 | Path to be used for Route.                                                                                                                                                                                                                                                                                                                                                                                 |