CORD-2737 Update docs to reflect moved profile manifests
Change-Id: I53fdf5abc160f5ccea19c33c2566f00f0292394c
diff --git a/docs/install.md b/docs/install.md
index 6f11468..bdfd28f 100644
--- a/docs/install.md
+++ b/docs/install.md
@@ -117,32 +117,42 @@
### POD Config
-The top level configuration for a build is the *POD config* file, which is a
-YAML file stored in [build/podconfig](https://github.com/opencord/cord/tree/{{
-book.branch }}/podconfig) that contains a list of variables that control how
-the build proceeds, and can override the configuration of the rest of the
-build.
+Each CORD *use-case* (e.g., R-CORD, M-CORD, E-CORD) has its own repository
+containing configuration files for that type of POD. All of these
+repositories appear in the source tree under `orchestration/profiles/`.
+For example, R-CORD's repository is
+[orchestration/profiles/rcord](https://github.com/opencord/rcord/tree/{{ book.branch }}).
-A minimal POD Config file must define two variables:
+The top level configuration for a build is the *POD config* file, a
+YAML file stored in each use-case repository's `podconfig` subdirectory.
+Each Pod config file contains a list of variables that control how
+the build proceeds, and can override the configuration of the rest of the
+build. A minimal POD config file must define two variables:
`cord_scenario` - the name of the *scenario* to use, which is defined in a
-directory under [build/scenarios](https://github.com/opencord/cord/tree/{{
-book.branch }}/scenarios).
+directory under [build/scenarios](https://github.com/opencord/cord/tree/{{ book.branch }}/scenarios).
-`cord_profile` - the name of a *profile* to use, defined as a YAML file in
-[build/platform-install/profile_manifests](https://github.com/opencord/platform-install/tree/{{
-book.branch }}/profile_manifests).
+`cord_profile` - the name of a *profile* to use, defined as a YAML file at
+the top level of the use-case repository - ex:
+[mcord-ng40.yml](https://github.com/opencord/mcord/blob/{{ book.branch }}/mcord-ng40.yml).
-The included POD configs must be named `<profile>-<scenario>.yml`, except for
-the `physical-example.yml` file which is used for a [Physical
-POD](install_physical.md) and requires a bit more work to configured.
+The naming convention for POD configs stored in the use case
+repository is `<profile>-<scenario>.yml` - ex:
+[mcord-ng40-virtual.yml](https://github.com/opencord/mcord/blob/{{ book.branch }}/podconfig/mcord-ng40-virtual.yml) builds the `virtual` scenario using the
+`mcord-ng40` profile. All such POD configs can be specified during a
+build using the `PODCONFIG` variable:
-POD configs are used during a build by passing them with the `PODCONFIG`
-variable to `make` - ex: `make PODCONFIG=rcord-virtual.yml config`
+```shell
+make PODCONFIG=rcord-virtual.yml config
+```
-You can also specify a full path to the POD config file to use with
+POD configs with arbitrary names can be specified using
`PODCONFIG_PATH`. This will override the `PODCONFIG` variable.
+```shell
+make PODCONFIG_PATH=./podconfig/my-pod-config.yml config
+```
+
### Profiles
The set of services that XOS on-boards into CORD -- the _Service Graph_, and
diff --git a/docs/install_physical.md b/docs/install_physical.md
index a724a24..34ad577 100644
--- a/docs/install_physical.md
+++ b/docs/install_physical.md
@@ -316,8 +316,7 @@
the external and the internal networks, what users the system should run during
the automated installation, and much more.
-POD configuration files are YAML files with extension .yml, contained in the
-`/cord/build/podconfig` directory in the dev VM. You can either create a new
+POD configuration files are YAML files with extension .yml. You can either create a new
file with your favorite editor or copy-and-edit an existing file. The
[physical-example.yml](https://github.com/opencord/cord/blob/{{ book.branch }}/podconfig/physical-example.yml)
configuration file is there for this purpose, and the most commonly set
diff --git a/docs/quickstarts.md b/docs/quickstarts.md
index 3122dcb..1ed0cea 100644
--- a/docs/quickstarts.md
+++ b/docs/quickstarts.md
@@ -59,12 +59,13 @@
echo 'cord ALL=(ALL) NOPASSWD:ALL' | sudo tee --append /etc/sudoers.d/90-cloud-init-users
```
-[Create a POD configuration](install.md#pod-config) file in the
-`~/cord/build/podconfig` directory, then run:
+[Create a POD configuration](install.md#pod-config) file using
+[physical-example.yml](https://github.com/opencord/cord/blob/{{ book.branch }}/podconfig/physical-example.yml)
+as a template. Then run:
```shell
cd ~/cord/build && \
-make PODCONFIG={YOUR_PODCONFIG_FILE.yml} config && \
+make PODCONFIG_PATH={PATH_TO_YOUR_PODCONFIG_FILE.yml} config && \
make -j4 build |& tee ~/build.out
```
diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md
index 50fc97f..629311f 100644
--- a/docs/troubleshooting.md
+++ b/docs/troubleshooting.md
@@ -240,7 +240,7 @@
[onos_debug_level](build_glossary.html#onosdebuglevel).
Add the names of the ONOS apps to `onos_debug_appnames` and add `onos-debug`
-to the `build_targets` list in your POD config file in `~/cord/build/podconfig/`.
+to the `build_targets` list in your POD config file.
This must be done before running the `make config` target - it won't affect an
already-running POD.
@@ -255,9 +255,11 @@
When a command to generate config such as `make PODCONFIG=rcord-mock.yml
config` is run, the following steps happen:
-1. The POD Config file is read, in this case `genconfig/rcord-mock.yml`, which
- specifies the scenario and profile.
-2. The Scenario config file is read, in this case `scenario/mock/config.yml`.
+1. The POD Config file is read, in this case
+[orchestration/profiles/rcord/podconfig/rcord-mock.yml](https://github.com/opencord/rcord/blob/{{ book.branch }}/podconfig/rcord-mock.yml),
+which specifies the scenario and profile.
+2. The Scenario config file is read, in this case
+[build/scenarios/mock/config.yml](https://github.com/opencord/cord/blob/{{ book.branch }}/scenarios/mock/config.yml).
3. The contents of these files are combined into a master config variable, with
the POD Config overwriting any config set in the Scenario.
4. The entire master config is written to `genconfig/config.yml`.
@@ -283,8 +285,8 @@
### `config` make target
-`config` requires a `PODCONFIG` argument, which is a name of a file in the
-`podconfig` directory. `PODCONFIG` defaults to `invalid`, so if you get errors
+`config` requires a `PODCONFIG` argument, which is the name of a file in
+`orchestration/profiles/<use-case>/podconfig/`. `PODCONFIG` defaults to `invalid`, so if you get errors
claiming an invalid config, you probably didn't set it, or set it to a filename
that doesn't exist.