Skip to content

Remove commented out sections #229

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 1, 2022
Merged

Remove commented out sections #229

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 1 addition & 34 deletions _docs/runtime/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ For both CLI wizard and Silent install:
</br>
{:/}

#### Git repository <!---and provider --->flags
#### Git repository flags

**Repository URLs**
The GitHub repository to house the installation definitions.
Expand All @@ -121,39 +121,6 @@ The Git token authenticating access to the GitHub installation repository.
* Silent install: Add the `--git-token` flag.


<!---**Enable Git providers**
Optional; required for GitLab, Bitbucket Server, and GitHub Enterprise Git providers.
Enable GitLab, Bitbucket Server, or GitHub Enterprise Server as the Git provider for the runtime and for the account.
>The Git provider defined for the first runtime in the account must be used for all the runtimes in the same account.

* CLI wizard and Silent install: Add the `--enable-git-provider` flag.

**Git provider**

Optional for GitHub; required for GitLab, Bitbucket Server, and GitHub Enterprise.
The name of the Git provider to use for the runtime and the account.

* CLI wizard and Silent install: Add the `--provider` flag, and define the provider name as either `gitlab`, `bitbucket-server` or `github`.

**Repository URL**
The `HTTPS` clone URL of the Git repository, or project in GitLab, including the `.git` suffix in which to install the runtime, in the format:
`https://<host>/<owner_reponame>.git[/subdirectory][?ref=branch]`
where:
* `<host>/<owner_reponame>.git` is the Git server followed by the username/organization and the name of the repo, identical to the HTTPS clone URL. For example, `https://github.com/codefresh-io/docs.codefresh.io.git`.
* `[/subdirectory]` (optional) is the path to a subdirectory within the repo. Whn omitted, the runtime is installed in the root of the repository. For example, `/docs/images`.
* `[?ref=branch]` (optional) is the `ref` queryParam to select a specific branch. When omitted, the runtime is installed in the default branch. For example, `codefresh-prod`.

> For GitLab, you must create the group with access to the project prior to the installation.

* CLI wizard: If the repo doesn't exist, for GitHub, GitLab, Bitbucket Server, GitHub Enterprise, Codefresh creates it during runtime installation.
* Silent install: Required. Add the `--repo` flag.

**Git user**
Optional; required only for Bitbucket Server.
The username for the Git account.

* CLI wizard and Silent install: For Bitbucket Server, add the `--git-user` flag, and define the username. For example, `codefresh` --->

{::nomarkdown}
</br>
{:/}
Expand Down
2 changes: 1 addition & 1 deletion _docs/runtime/requirements.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The requirements listed are the **_minimum_** requirements to provision **_hybri
| Ingress controller| Configured on Kubernetes cluster and exposed from the cluster. {::nomarkdown} <br>Supported and tested ingress controllers include: <ul><li>Ambassador</li>{:/}(see [Ambassador ingress configuration](#ambassador-ingress-configuration)){::nomarkdown}<li>AWS ALB (Application Load Balancer)</li>{:/} (see [AWS ALB ingress configuration](#aws-alb-ingress-configuration)){::nomarkdown}<li>Istio</li>{:/} (see [Istio ingress configuration](#istio-ingress-configuration)){::nomarkdown}<li>NGINX Enterprise (nginx.org/ingress-controller)</li>{:/} (see [NGINX Enterprise ingress configuration](#nginx-enterprise-ingress-configuration)){::nomarkdown}<li>NGINX Community (k8s.io/ingress-nginx)</li> {:/} (see [NGINX Community ingress configuration](#nginx-community-version-ingress-configuration)){::nomarkdown}<li>Trafik</li>{:/}(see [Traefik ingress configuration](#traefik-ingress-configuration))|
|Node requirements| {::nomarkdown}<ul><li>Memory: 5000 MB</li><li>CPU: 2</li></ul>{:/}|
|Cluster permissions | Cluster admin permissions |
|Git providers |{::nomarkdown}<ul><li>GitHub</li><!--<li>GitLab</li><li>Bitbucket Server</li><li>Bitbucket Cloud</li><li>GitHub Enterprise</li>--></ul>{:/}|
|Git providers |{::nomarkdown}<ul><li>GitHub</li></ul>{:/}|
|Git access tokens | {::nomarkdown}Runtime Git token:<ul><li>Valid expiration date</li><li>Scopes: <span style="font-family: var(--font-family-monospace); font-size: 87.5%; color: #ad6800; background-color: #fffbe6">repo</span> and <span style="font-family: var(--font-family-monospace); font-size: 87.5%; color: #ad6800; background-color: #fffbe6">admin-repo.hook</span></li></ul>Personal access Git token:<ul><li>Valid expiration date</li><li>Scopes: <span style="font-family: var(--font-family-monospace); font-size: 87.5%; color: #ad6800; background-color: #fffbe6">repo</span></li></ul></li></ul>{:/}|

<!---### General ingress configuration
Expand Down