Skip to content

Commit

Permalink
Merge branch 'main' into microservice_control
Browse files Browse the repository at this point in the history
  • Loading branch information
jmthomas committed Feb 22, 2025
2 parents 16d96c1 + b0aaee5 commit 3dc3c22
Show file tree
Hide file tree
Showing 194 changed files with 2,161 additions and 926 deletions.
4 changes: 3 additions & 1 deletion .env
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ OPENC3_SR_BUCKET_PASSWORD=scriptrunnerminiopassword
OPENC3_SERVICE_PASSWORD=openc3service
# Build and repository settings
ALPINE_VERSION=3.19
ALPINE_BUILD=6
ALPINE_BUILD=7
APK_URL=https://dl-cdn.alpinelinux.org
RUBYGEMS_URL=https://rubygems.org
PYPI_URL=https://pypi.org
Expand All @@ -57,6 +57,8 @@ SECRET_KEY_BASE=bdb4300d46c9d4f116ce3dbbd54cac6b20802d8be1c2333cf5f6f90b1627799a
OPENC3_CLOUD=local
# Change to arn:aws-us-gov for deploying to AWS Gov Cloud
OPENC3_AWS_ARN_PREFIX=arn:aws
# Default to not CI - blank string
CI=""

# This can be used to set the default language for generators
# OPENC3_LANGUAGE=ruby
Expand Down
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ openc3/spec/examples.txt
coverage/
profile/
plugins/DEFAULT/
**/python/prof/
*.dSYM/

# local env files
.env.local
Expand Down
4 changes: 2 additions & 2 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ To build you can use an environment variable `SSL_CERT_FILE` or it will default

If you're building and want to use a private Rubygems, NPM or APK server (e.g. Nexus) you can update the following environment variables: RUBYGEMS_URL, NPM_URL, APK_URL, and more in the .env file. Example values:

- ALPINE_VERSION=3.18
- ALPINE_BUILD=9
- ALPINE_VERSION=3.19
- ALPINE_BUILD=7
- RUBYGEMS_URL=https://rubygems.org
- NPM_URL=https://registry.npmjs.org
- APK_URL=http://dl-cdn.alpinelinux.org
Expand Down
4 changes: 2 additions & 2 deletions docs.openc3.com/docs/development/developing.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ openc3inc/openc3-ruby latest aa158bbb9539 8 days ago

If you're building in a offline environment or want to use a private Rubygems, NPM or APK server (e.g. Nexus), you can update the following environment variables: RUBYGEMS_URL, NPM_URL, APK_URL, and more in the [.env](https://github.com/openc3/cosmos/blob/main/.env) file. Example values:

ALPINE_VERSION=3.18<br/>
ALPINE_BUILD=9<br/>
ALPINE_VERSION=3.19<br/>
ALPINE_BUILD=7<br/>
RUBYGEMS_URL=https://rubygems.org<br/>
NPM_URL=https://registry.npmjs.org<br/>
APK_URL=http://dl-cdn.alpinelinux.org<br/>
Expand Down
2 changes: 1 addition & 1 deletion docs.openc3.com/docs/getting-started/key_concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ COSMOS uses an [environment file](https://docs.docker.com/compose/environment-va

Per [Kubernetes.io](https://kubernetes.io/), "Kubernetes, also known as K8s, is an open-source system for automating deployment, scaling, and management of containerized applications. It groups containers that make up an application into logical units for easy management and discovery." [COSMOS Enterprise](https://openc3.com/enterprise) provides [Helm charts](https://helm.sh/docs/topics/charts/) for easy deployment to Kubernetes in various cloud environments.

COSMOS Enterprise also provides [Terraform](https://www.terraform.io/) scripts to deploy COSMOS infrastructure on various cloud environments.
COSMOS Enterprise also provides configuration to deploy COSMOS infrastructure on various cloud environments (e.g. CloudFormation template on AWS).

## Frontend

Expand Down
30 changes: 26 additions & 4 deletions docs.openc3.com/docs/guides/scripting-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -3284,6 +3284,8 @@ These methods allow the user to script Table Manager.

### table_create_binary

> Since 6.1.0

Creates a table binary based on a table definition file. You can achieve the same result in the Table Manager GUI with File->New File. Returns the path to the binary file created.

Ruby / Python Syntax:
Expand All @@ -3299,19 +3301,39 @@ table_create_binary(<Table Definition File>)
Ruby Example:

```ruby
table = table_create_binary("INST/tables/config/ConfigTables_def.txt") #=>
# {"filename"=>"INST/tables/bin/ConfigTables.bin"}
# Full example of using table_create_binary and then editing the binary
require 'openc3/tools/table_manager/table_config'
# This returns a hash: {"filename"=>"INST/tables/bin/MCConfigurationTable.bin"}
table = table_create_binary("INST/tables/config/MCConfigurationTable_def.txt")
file = get_target_file(table['filename'])
table_binary = file.read()

# Get the definition file so we can process the binary
def_file = get_target_file("INST/tables/config/MCConfigurationTable_def.txt")
# Access the internal TableConfig to process the definition
config = OpenC3::TableConfig.process_file(def_file.path())
# Grab the table by the definition name, e.g. TABLE "MC_Configuration"
table = config.table('MC_CONFIGURATION')
# Now you can read or write individual items in the table
table.write("MEMORY_SCRUBBING", "DISABLE")
# Finally write the table.buffer (the binary) back to storage
put_target_file("INST/tables/bin/MCConfigurationTable_NoScrub.bin", table.buffer)
```

Python Example:

```python
table = table_create_binary("INST/tables/config/ConfigTables_def.txt") #=>
# {'filename': 'INST/tables/bin/ConfigTables.bin'}
# NOTE: TableConfig and other TableManager classes do not yet exist in Python
# So editing like the above Ruby example is not yet possible

# Returns a dict: {'filename': 'INST/tables/bin/ConfigTables.bin'}
table = table_create_binary("INST/tables/config/ConfigTables_def.txt")
```

### table_create_report

> Since 6.1.0

Creates a table binary based on a table definition file. You can achieve the same result in the Table Manager GUI with File->New File. Returns the path to the binary file created.

Ruby / Python Syntax:
Expand Down
32 changes: 19 additions & 13 deletions docs.openc3.com/src/pages/index.js
Original file line number Diff line number Diff line change
@@ -1,24 +1,29 @@
import React from 'react';
import clsx from 'clsx';
import Link from '@docusaurus/Link';
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
import Layout from '@theme/Layout';
import HomepageFeatures from '@site/src/components/HomepageFeatures';
import React from "react";
import clsx from "clsx";
import Link from "@docusaurus/Link";
import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
import Layout from "@theme/Layout";
import HomepageFeatures from "@site/src/components/HomepageFeatures";

import styles from './index.module.css';
import styles from "./index.module.css";

function HomepageHeader() {
const {siteConfig} = useDocusaurusContext();
const { siteConfig } = useDocusaurusContext();
return (
<header className={clsx('hero hero--primary', styles.heroBanner)}>
<header className={clsx("hero hero--primary", styles.heroBanner)}>
<div className="container">
<img src={`${siteConfig.baseUrl}img/black_logo.svg`} width="400px"></img>
<img
src={`${siteConfig.baseUrl}img/black_logo.svg`}
width="400px"
alt="OpenC3"
></img>
<h1 className="hero__title">{siteConfig.title}</h1>
<p className="hero__subtitle">{siteConfig.tagline}</p>
<div className={styles.buttons}>
<Link
className="button button--secondary button--lg"
to="/docs/getting-started">
to="/docs/getting-started"
>
Get Started
</Link>
</div>
Expand All @@ -28,11 +33,12 @@ function HomepageHeader() {
}

export default function Home() {
const {siteConfig} = useDocusaurusContext();
const { siteConfig } = useDocusaurusContext();
return (
<Layout
title={`Hello from ${siteConfig.title}`}
description="Description will go into a meta tag in <head />">
description="Description will go into a meta tag in <head />"
>
<HomepageHeader />
<main>
<HomepageFeatures />
Expand Down
2 changes: 1 addition & 1 deletion docs/404.html

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/assets/js/9d6e81d0.6a5fa00e.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion docs/assets/js/9d6e81d0.f96fdb5c.js

This file was deleted.

Large diffs are not rendered by default.

Loading

0 comments on commit 3dc3c22

Please sign in to comment.