UNCLASSIFIED - NO CUI

Skip to content
Snippets Groups Projects
Commit ea5c06c7 authored by Micah Nagel's avatar Micah Nagel
Browse files

Merge branch 'docs-patch-01' into 'master'

Docs -  Format And Link Fixes

See merge request platform-one/big-bang/bigbang!1465
parents 601e77f6 7291a3d2
No related branches found
No related tags found
2 merge requests!1658Draft: Merge branch 'tempo_tracing_updates' into 'master',!1465Docs - Format And Link Fixes
......@@ -2,7 +2,7 @@
Each Big Bang Package is present in the [Big Bang Package](https://repo1.dso.mil/platform-one/big-bang/apps) repository and broken up into several sub-groupings.
Each package has _at least_ two `CODEOWNERS`. Responsibilities are outlined [here](ApplicationOwners.md).
Each package has _at least_ two `CODEOWNERS`. Responsibilities are outlined [here](PackageOwner.md).
[[_TOC_]]
......
......@@ -22,5 +22,5 @@
### Where is the best place to look for documentation on BigBang Packages?
- Our goal is to have these docs available on a webpage hosted on the BigBang Cluster using Hugo
(https://docs.bigbang.dev by default) (look [here](https://repo1.dso.mil/platform-one/big-bang/bigbang/-/blob/master/charter/PackageDocumentation.md) for more info)
(https://docs.bigbang.dev by default) (look [here](./PackageDocumentation.md) for more info)
- This allows us to support a centralized location for package configuration documentation, while allowing support for dynamically added versions of distributed packages in a maintainable way.
......@@ -26,7 +26,7 @@ Before configuring Big Bang, it is expected that you have already setup:
- A [SOPS key pair](encryption.md)
- A Git repository to hold your configuration
- Pull credentials for the Git repository (if not public)
- An Iron Bank robot account for production, or a non-robot account for testing. Reference [Iron Bank authentication](https://repo1.dso.mil/platform-one/big-bang/bigbang/-/blob/master/docs/b_troubleshooting.md#iron-bank-authentication) for additional details.
- An Iron Bank robot account for production, or a non-robot account for testing. Reference [Iron Bank authentication](./troubleshooting.md#iron-bank-authentication) for additional details.
- Certificates specific to your environment (if needed)
## Minimum Viable Configuration
......
......@@ -63,7 +63,7 @@ spec:
### Was Something Important Blocked? <a name="something-important-blocked"></a>
There are a few ways to determine if a network policy is blocking egress or ingress to or from a pod.
- Test things from the pod's perspective using ssh/exec. See [this portion](https://repo1.dso.mil/platform-one/big-bang/bigbang/-/blob/master/docs/guides/deployment_scenarios/sso_quickstart.md#step-18-update-inner-cluster-dns-on-the-workload-cluster) of the keycloak quickstart for an example of how do to that.
- Test things from the pod's perspective using ssh/exec. See [this portion](../../guides/deployment_scenarios/sso_quickstart.md#step-18-update-inner-cluster-dns-on-the-workload-cluster) of the keycloak quickstart for an example of how do to that.
- Curl a pod's IP from another pod to see if network polices are blocking that traffic. Use `kubectl pod -o wide -n <podNamespace>` to see pod IP addresses.
- Check the pod logs (or curl from one container to the service) for a `context deadline exceeded` or `connection refused` message.
......
......@@ -5,8 +5,8 @@ Big Bang has configuration for Single Sign-On (SSO) authentication using an iden
## Prerequisites
The development environment can be set up in one of two ways:
1. Two k3d clusters with keycloak in one cluster and Big Bang and all other apps in the second cluster (see [this quick start guide](https://repo1.dso.mil/platform-one/big-bang/bigbang/-/blob/master/docs/guides/deployment_scenarios/sso_quickstart.md) for more information)
2. One k3d cluster using metallb to have keycloak, Big Bang, and all other apps in the one cluster (see [this example config](https://repo1.dso.mil/platform-one/big-bang/bigbang/-/blob/master/docs/example_configs/keycloak-dev-values.yaml) for more information)
1. Two k3d clusters with keycloak in one cluster and Big Bang and all other apps in the second cluster (see [this quick start guide](../../guides/deployment_scenarios/sso_quickstart.md) for more information)
2. One k3d cluster using metallb to have keycloak, Big Bang, and all other apps in the one cluster (see [this example config](https://repo1.dso.mil/platform-one/big-bang/bigbang/-/blob/master/docs/example_configs/keycloak-dev-values.yaml) for more information)
## Integration
......
......@@ -11,7 +11,7 @@ Usually, Helm charts come with a set of Helm tests that can be run to test the d
## Prerequisites
- Package helm chart with CI settings pointing to one of bigbang's [package pipelines](https://repo1.dso.mil/platform-one/big-bang/bigbang/-/blob/ci-integration-doc/docs/developer/package-integration/package-integration-pipeline.md)
- Package helm chart with CI settings pointing to one of bigbang's [package pipelines](./package-integration-pipeline.md)
## Integration
......
......@@ -26,7 +26,7 @@ After [graduating your package](https://repo1.dso.mil/platform-one/bbtoc/-/tree/
1. Make a branch from the BigBang chart repository `master` branch. You can automatically create a branch from the Repo1 Gitlab issue. Or, in some cases you might manually create the branch. Name the branch with your issue number. For example, if your issue number is `9999` then your branch name can be `9999-my-description`. It is best practice to make branch names short and simple.
1. Make sure the files described in this [document](https://repo1.dso.mil/platform-one/big-bang/bigbang/-/blob/master/docs/developer/package-integration/package-integration-flux.md) have been generated in `chart/templates/<your-package-name>` directory
1. Make sure the files described in this [document](./package-integration-flux.md) have been generated in `chart/templates/<your-package-name>` directory
1. More details about secret-*.yaml: The secret template is where the code for secrets go. Typically you will see secrets for imagePullSecret, sso, database, and possibly object storage. These secrets are a BigBang chart enhancement. They are created conditionally based on what the user enables in the config. For example if the app supports SSO and will need a Certificate Authority supplied to trust the connection to the IdP there should be a `secret-ca.yaml` template to populate a secret with the `sso.certificate_authority` value in the application namespace.
......
......@@ -35,10 +35,10 @@ Why 2 VMs? 2 reasons:
* This quick start assumes you have kubectl installed on your Administrator Workstation
### Additional Auth Service and Keycloak documentation can be found in these locations
* <https://repo1.dso.mil/platform-one/big-bang/apps/core/authservice>
* <https://repo1.dso.mil/platform-one/big-bang/bigbang/-/blob/master/charter/packages/authservice/Architecture.md>
* <https://repo1.dso.mil/platform-one/big-bang/apps/security-tools/keycloak>
* <https://repo1.dso.mil/platform-one/big-bang/bigbang/-/blob/master/charter/packages/keycloak/Architecture.md>
* [Authservice](https://repo1.dso.mil/platform-one/big-bang/apps/core/authservice)
* [Authservice Architecture](../../../charter/packages/authservice/Architecture.md)
* [Keycloak](https://repo1.dso.mil/platform-one/big-bang/apps/security-tools/keycloak)
* [Keycloak Architecture](../../../charter/packages/keycloak/Architecture.md)
## Step 1: Provision 2 Virtual Machines
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment