Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
91 changes: 90 additions & 1 deletion docs/how-to/developer/concepts/app-charts/app-charts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import TabItem from '@theme/TabItem';
This guide explores working with application charts. App charts are reusable application templates packaged as Helm charts that allow users to deploy preconfigured applications. For more information see the [application charts reference](../../../../reference/concepts/appcharts.md) page.

## View Application Charts

<Tabs>
<TabItem value="ui" label="UI" default>

Expand All @@ -37,7 +38,95 @@ epinio app chart list
</TabItem>
</Tabs>

### Application Charts CRUD Coming Soon!
## Create an Application Chart

<Tabs>
<TabItem value="ui" label="UI" default>

Click **Create** on the Application Charts page to open the creation modal. Here you can provide a name and short description which will be displayed when creating an application, a detailed description for display in the table, as well as a Helm Chart URL and/or a Helm Repo URL. You can also establish settings that will prompt the user for values during app creation if they select the corresponding chart.

<img
src={require('./charts-create-modal.png').default}
alt="Create App Chart Modal"
width="800"
/>

</TabItem>

<TabItem value="cli" label="CLI">

Create an application chart:

```console
epinio app chart create --name mychart \
--short-description "My application chart" \
--description "A longer description of my application chart" \
--helm-repo https://charts.example.com \
--helm-chart https://charts.example.com/mychart-1.0.0.tgz \
--set replicaCount=2 \
--set image.tag=latest
```

The `--set` flag takes a `key=value` pair and can be repeated to provide multiple values.

</TabItem>
</Tabs>

## Edit an Application Chart

<Tabs>
<TabItem value="ui" label="UI" default>

Select **Edit** from the action menu for the row of the app chart you wish to edit. Use caution when editing charts that are being used by applications, as you may cause issues for future rebuilds.

<img
src={require('./charts-edit-modal.png').default}
alt="Edit App Chart Modal"
width="800"
/>

</TabItem>

<TabItem value="cli" label="CLI">

Update an application chart. Flags you do not set leave the corresponding fields unchanged:

```console
epinio app chart update mychart \
--short-description "An updated description" \
--helm-chart https://charts.example.com/mychart-1.1.0.tgz \
--set replicaCount=3
```

</TabItem>
</Tabs>

## Delete an Application Chart

<Tabs>
<TabItem value="ui" label="UI" default>

Open the action menu for the application chart and select **Delete**. Confirm the deletion.

<img
src={require('./charts-delete-modal.png').default}
alt="Delete App Chart Modal"
width="400"
/>

</TabItem>

<TabItem value="cli" label="CLI">

Delete an application chart:

```console
epinio app chart delete mychart
```

</TabItem>
</Tabs>


## Additional CLI Commands
For additional documentation on the CLI commands above, along with additional commands, see the [epinio app chart](../../../../reference/cli/app/chart/epinio_app_chart.md) CLI reference.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/how-to/developer/concepts/app-charts/charts-screen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 5 additions & 1 deletion docs/how-to/developer/concepts/applications/applications.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,9 @@ Provide your application source to Epinio. If you have an [application manifest]
- GitHub
- GitLab

After providing your source, select the [application chart](../app-charts/app-charts.mdx) and builder image you would like Epinio to use.
Selecting any of the Git options will allow you to select from your [git configurations](../git-configs/git-configs.mdx) so Epinio can access prive repos/projects.

After providing your source, select the [builder image](../builder-images/builder-images.mdx) you would like Epinio to use when building your application and the [application chart](../app-charts/app-charts.mdx) you would like Epinio to use when deploying it.

<img
src={require('./apps-create-modal.png').default}
Expand Down Expand Up @@ -182,6 +184,8 @@ epinio app delete myapp

## Additional Actions

The following actions are available from the action menu in the Applications table or on the Application Details page.

### App Shell

<Tabs>
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
132 changes: 132 additions & 0 deletions docs/how-to/developer/concepts/builder-images/builder-images.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
---
sidebar_label: Builder Images
sidebar_position: 7
title: Builder Images
description: How to use Epinio builder images.
keywords: [epinio, kubernetes, builder images]
doc-type: [how-to]
doc-topic: [epinio, how-to, builder images]
doc-persona: [epinio-developer, epinio-operator]
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

This guide explores working with builder images. Builder images transform source code into runnable container images. For more information see the [builder images reference](../../../../reference/customization/staging.md) page.

## View Builder Images

<Tabs>
<TabItem value="ui" label="UI" default>

To view all available builder images, navigate to the **Builder Images** page under the **Advanced** section of the side navigation menu.

<img
src={require('./builder-screen.png').default}
alt="View of the Builder Images screen"
/>

</TabItem>
<TabItem value="cli" label="CLI">

List all known builder images:

```console
epinio buildimage list
```

Show the details of a single builder image:

```console
epinio buildimage show myimage
```

</TabItem>
</Tabs>

## Create a Builder Image

<Tabs>
<TabItem value="ui" label="UI" default>

Click **Create** on the Builder Images page to open the creation modal. Here you can provide a name, descriptions and the image itself.

<img
src={require('./builder-create-modal.png').default}
alt="Create Builder Image Modal"
width="800"
/>

</TabItem>

<TabItem value="cli" label="CLI">

Create a builder image. Both `--name` and `--image` are required:

```console
epinio buildimage create --name myimage \
--image paketobuildpacks/builder-jammy-full:latest \
--short-description "My builder image" \
--description "A longer description of my builder image"
```

</TabItem>
</Tabs>

## Edit a Builder Image

<Tabs>
<TabItem value="ui" label="UI" default>

Select **Edit** from the action menu for the row of the builder image you wish to edit. Use caution when editing images that are being used by applications, as you may cause issues for future rebuilds.

<img
src={require('./builder-edit-modal.png').default}
alt="Edit Builder Image Modal"
width="800"
/>

</TabItem>

<TabItem value="cli" label="CLI">

Update a builder image. Flags you do not set leave the corresponding fields unchanged:

```console
epinio buildimage update myimage \
--image paketobuildpacks/builder-jammy-full:0.4.0 \
--short-description "An updated description"
```

</TabItem>
</Tabs>

## Delete a Builder Image

<Tabs>
<TabItem value="ui" label="UI" default>

Open the action menu for the builder image and select **Delete**. Confirm the deletion.

<img
src={require('./builder-delete-modal.png').default}
alt="Delete Builder Image Modal"
width="400"
/>

</TabItem>

<TabItem value="cli" label="CLI">

Delete a builder image:

```console
epinio buildimage delete myimage
```

</TabItem>
</Tabs>


## Additional CLI Commands
For additional documentation on the CLI commands above, along with additional commands, see the [epinio buildimage](../../../../reference/cli/buildimage/epinio_buildimage.md) CLI reference.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
108 changes: 108 additions & 0 deletions docs/how-to/developer/concepts/git-configs/git-configs.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
---
sidebar_label: Git Configurations
sidebar_position: 8
title: Git Configurations
description: How to use Epinio git configurations.
keywords: [epinio, kubernetes, git configuartions]
doc-type: [how-to]
doc-topic: [epinio, how-to, git configurations]
doc-persona: [epinio-developer, epinio-operator]
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

This guide explores working with git configurations. Git configurations enable cloning of private repositories, disabling of SSL verification, and/or extending verification through a custom bundle of certificates. For more information see the [git configurations reference](../../../../reference/concepts/git_configuration.md) page.

## View Git Configurations

<Tabs>
<TabItem value="ui" label="UI" default>

To view all available git configurations, navigate to the **Git Configs** page under the **Advanced** section of the side navigation menu.

<img
src={require('./git-configs-screen.png').default}
alt="View of the Git Configs screen"
/>

</TabItem>
<TabItem value="cli" label="CLI">

List all git configs:

```console
epinio gitconfig list
```

</TabItem>
</Tabs>

## Create a Git Configuration

<Tabs>
<TabItem value="ui" label="UI" default>

Click **Create** on the Git Configs page to open the creation modal. First, you must provide a unique id for your git config.

Epinio offers several git providers to choose from, including GitHub and GitLab. If you select enterprise versions of GitHub or GitLab, you will also have to provide the host URL.

You can also provide your Git username, as well as a password/token, so Epinio can access private repos/projects.

Finally, you can provide epinio with git certificates and toggle some addtional config options.

<img
src={require('./git-configs-create-modal.png').default}
alt="Create Git Config Modal"
width="800"
/>

</TabItem>

<TabItem value="cli" label="CLI">

Create git config:

```console
epinio gitconfig create github-epinio-example-go-configuration https://github.com \
--git-provider github \
--user-org epinio \
--repository example-go \
--skip-ssl \
--username myuser \
--password abcde12345 \
--cert-file /path/to/some/certfile
```

</TabItem>
</Tabs>

## Delete a Git Configuration

<Tabs>
<TabItem value="ui" label="UI" default>

Open the action menu for the git config and select **Delete**. Confirm the deletion.

<img
src={require('./git-configs-delete-modal.png').default}
alt="Delete Git Config Modal"
width="400"
/>

</TabItem>

<TabItem value="cli" label="CLI">

Delete git config:

```console
epinio gitconfig delete my-git-config
```

</TabItem>
</Tabs>


## Additional CLI Commands
For additional documentation on the CLI commands above, along with additional commands, see the [epinio gitconfig chart](../../../../reference/cli/gitconfig/epinio_gitconfig.md) CLI reference.
Loading